@sitevision/api 2024.9.2 → 2025.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2024.9.2",
+  "version": "2025.1.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -30,5 +30,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "4c337a5be501c6f903a0bdc2affe4b721f78980e"
+  "gitHead": "fef445686db4d5d6ccf41b93179735c9604c05f8"
 }

package/server/LinkValueBuilder/index.d.ts

@@ -69,11 +69,11 @@ import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder
 export interface LinkValueBuilder extends Builder {
   /**
    * Sets the target.
-   * @param anURL the link target URL
+   * @param aURL the link target URL
    * @return this builder
-   * @throws IllegalArgumentException if <code>anURL</code> is <code>null</code> or whitespace only
+   * @throws IllegalArgumentException if <code>aURL</code> is <code>null</code> or whitespace only
    */
-  setExternalTarget(anURL: String | string): LinkValueBuilder;
+  setExternalTarget(aURL: String | string): LinkValueBuilder;
 
   /**
    * Sets the target.

package/server/NodeFilterUtil/index.d.ts

@@ -5,6 +5,7 @@ import type { Collection } from "../../types/java/util/Collection";
 import type { FilterSplit } from "../../types/senselogic/sitevision/api/base/FilterSplit";
 import type { CompoundAndFilterBuilder } from "../CompoundAndFilterBuilder";
 import type { CompoundOrFilterBuilder } from "../CompoundOrFilterBuilder";
+
 import type { String } from "../../types/java/lang/String";
 
 import type { Calendar } from "../../types/java/util/Calendar";
@@ -202,6 +203,36 @@ export interface NodeFilterUtil {
    */
   getNonNullFilter(): Filter;
 
+  /**
+   * Gets a filter that skips a given number of nodes.
+   *
+   *  <p>
+   *     <em>Note!</em> The skip filter is typically used in combination with a <em>Compound AND Filter</em>.
+   *     Example:
+   *  </p>
+   *  <ul>
+   *     <li>
+   *        This filter skips 5 nodes, regardless of type:<br>
+   *        <pre><code>   filter = nodeFilterUtil.getSkipFilter(5);</code></pre>
+   *     </li>
+   *     <li>
+   *        This page filter skips 5 nodes <em>(i.e. rejects first 5 sv:page nodes that otherwise would have been accepted)</em>:<br>
+   *        <pre><code>   filter = nodeFilterUtil.getCompoundAndFilterBuilder()
+   *        .addFilter(nodeFilterUtil.getPrimaryNodeTypeFilter("sv:page"))
+   *        .addFilter(nodeFilterUtil.getSkipFilter(5))
+   *        .build();</code></pre>
+   *     </li>
+   *  </ul>
+   *  <p>
+   *     Also note that this filter is <em>stateful</em>, i.e. a created filter instance can't be used more than one time.
+   *  </p>
+   * @param aSkip the number of nodes to skip
+   * @return a filter that rejects aSkip number of nodes
+   * @throws IllegalArgumentException if aSkip is less than zero
+   * @since Sitevision 2025.01.1
+   */
+  getSkipFilter(aSkip: number): Filter;
+
   /**
    * Gets a filter that inverts the result of another filter.
    * @param aFilter the filter to invert

package/server/NodeFilterUtil/index.js

@@ -15,6 +15,7 @@ var _default = exports["default"] = {
   getNeverAcceptFilter: function getNeverAcceptFilter() {},
   getNullFilter: function getNullFilter() {},
   getNonNullFilter: function getNonNullFilter() {},
+  getSkipFilter: function getSkipFilter() {},
   getInvertedFilter: function getInvertedFilter() {},
   getIdentifierFilter: function getIdentifierFilter() {},
   getIdentifierPrefixFilter: function getIdentifierPrefixFilter() {},

package/server/NodeIteratorUtil/index.d.ts

@@ -42,15 +42,15 @@ export interface NodeIteratorUtil {
    *        ...
    *     }</code></pre>
    * @param aNodeIterator a NodeIterator, must not be null
-   * @param aNodeFilter a Node Filter, must not be null
+   * @param aFilter a Node Filter, must not be null
    * @return a filtered NodeIterator
-   * @throws NullPointerException if aNodeIterator or aNodeFilter is null
+   * @throws NullPointerException if aNodeIterator or aFilter is null
    * @see NodeFilterUtil
    * @since Sitevision 8.1
    */
   getFilteredNodeIterator(
     aNodeIterator: NodeIterator,
-    aNodeFilter: Filter
+    aFilter: Filter
   ): NodeIterator;
 
   /**
@@ -61,8 +61,8 @@ export interface NodeIteratorUtil {
    *  </p>
    *  <ul>
    *     <li>
-   *        <em>Convenience.</em> This method combines {@link javax.jcr.Session#getNodeByIdentifier(String)} and {@link Node#getNodes()},
-   *        i.e. a shortcut to get an iterator without having to actually lookup/resolve the parent node.
+   *        <em>Convenience.</em> This method combines {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getNodeByIdentifier(String)}
+   *        and {@link Node#getNodes()}, i.e. a shortcut to get an iterator without having to actually lookup/resolve the parent node.
    *     </li>
    *     <li>
    *        <em>Permission workaround.</em> This method does <em>not</em> do any permission checks on the resolved parent Node, i.e.
@@ -90,8 +90,8 @@ export interface NodeIteratorUtil {
    *  </p>
    *  <ul>
    *     <li>
-   *        <em>Convenience.</em> This method combines {@link javax.jcr.Session#getNodeByIdentifier(String)} and {@link #getMenuItems(Node)},
-   *        i.e. a shortcut to get a menu iterator without having to actually lookup/resolve the parent node.
+   *        <em>Convenience.</em> This method combines {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getNodeByIdentifier(String)}
+   *        and {@link #getMenuItems(Node)}, i.e. a shortcut to get a menu iterator without having to actually lookup/resolve the parent node.
    *     </li>
    *     <li>
    *        <em>Permission workaround.</em> This method does <em>not</em> do any permission checks on the resolved parent Node, i.e.
@@ -121,7 +121,7 @@ export interface NodeIteratorUtil {
    *  </p>
    *  <ul>
    *     <li>
-   *        <em>Convenience.</em> This method combines {@link javax.jcr.Session#getNodeByIdentifier(String)} and
+   *        <em>Convenience.</em> This method combines {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getNodeByIdentifier(String)} and
    *        {@link #getMenuItemsIncludingFolders(Node)}, i.e. a shortcut to get a menu iterator without having to actually
    *        lookup/resolve the parent node.
    *     </li>
@@ -164,20 +164,46 @@ export interface NodeIteratorUtil {
    *  </p>
    * @param aNodeIterator a node iterator
    * @param aFilter a node filter
-   * @param aMaxNodesToFind max number of nodes to include in the result
-   * @return a list of nodes that matches <code>aFilter</code>, never <code>null</code>.&#xA; The list will contain at most <code>aMaxNodesToFind</code> nodes.&#xA; If <code>aFilter</code> is <code>null</code>, the filter will be ignored (all nodes will be accepted).&#xA; If <code>aNodeIterator</code> is <code>null</code>, an empty list will be returned.&#xA; If <code>aMaxNodesToFind</code> is negative, an empty list will be returned.
+   * @param aLimit max number of nodes to include in the result
+   * @return a list of nodes that matches <code>aFilter</code>, never <code>null</code>.&#xA; The list will contain at most aLimit nodes.&#xA; If aNodeIterator is null, an empty list will be returned.&#xA; If aFilter is null, the filter will be ignored (all nodes will be accepted).&#xA; If aLimit is negative or zero, an empty list will be returned.
    * @since Sitevision 3.6.2
    */
-  findNodes(
+  findNodes(aNodeIterator: NodeIterator, aFilter: Filter, aLimit: number): List;
+
+  /**
+   * Gets a max-sized node list from a node iterator that matches a specified filter, skipping a specified number of matching nodes.
+   *
+   *  <p>
+   *     Executing <code>findMoreNodes(nodeIterator, filter, 0, 10)</code> is conceptually equivalent
+   *     to executing <code>findNodes(nodeIterator, filter, 10)</code>.
+   *  </p>
+   *
+   *  <p>
+   *     <em>Tip!</em> Use {@link senselogic.sitevision.api.node.NodeFilterUtil} to get an appropriate node filter.
+   *  </p>
+   * @param aNodeIterator a node iterator
+   * @param aFilter a node filter
+   * @param aSkip number of matching nodes to skip
+   * @param aLimit max number of nodes to include in the result
+   * @return a list of nodes that matches aFilter, never null.&#xA; The list will contain at most aLimit number of nodes and aSkip number of nodes will be ignored.&#xA; If aNodeIterator is null, an empty list will be returned.&#xA; If aFilter is null, the filter will be ignored (all nodes will be accepted).&#xA; If aSkip is negative or zero, no nodes will be skipped.&#xA; If aLimit is negative or zero, an empty list will be returned.
+   * @since Sitevision 2025.01.1
+   */
+  findMoreNodes(
     aNodeIterator: NodeIterator,
     aFilter: Filter,
-    aMaxNodesToFind: number
+    aSkip: number,
+    aLimit: number
   ): List;
 
   /**
    * Gets a list of all nodes from a node iterator that matches a specified filter.
    *
    *  <p>
+   *     Executing <code>findAll(nodeIterator, null)</code> is conceptually equivalent
+   *     to executing <code>toList(nodeIterator)</code>.
+   *  </p>
+   *
+   *  <p>
    *     <em>Tip!</em> Use {@link senselogic.sitevision.api.node.NodeFilterUtil} to get
    *     an appropriate node filter. If the list of nodes should be sorted by a specific property value,
    *     you would typically use {@link senselogic.sitevision.api.node.NodeComparatorUtil}

package/server/NodeIteratorUtil/index.js

@@ -13,6 +13,7 @@ var _default = exports["default"] = {
   getMenuItemsIncludingFoldersByIdentifier: function getMenuItemsIncludingFoldersByIdentifier() {},
   findFirst: function findFirst() {},
   findNodes: function findNodes() {},
+  findMoreNodes: function findMoreNodes() {},
   findAll: function findAll() {},
   toList: function toList() {},
   split: function split() {}

package/server/NodeTreeUtil/index.d.ts

@@ -84,6 +84,22 @@ export interface NodeTreeUtil {
    */
   getWebPathNodes(aDescendantNode: Node): List;
 
+  /**
+   * Find a portlet with a specific content identifier on a page node.
+   *
+   *  <p>
+   *     The <em>content identifier</em> of the portlet is determined by the <em>contentIdentifier</em> property.
+   *  </p>
+   * @param aPageNode the page node that has content, typically a sv:page or sv:article
+   * @param aContentIdentifier the content identifier of the sv:portlet that should be found
+   * @return the first occurrence of a sv:portlet with matching aContentIdentifier, or null if no such portlet can be found&#xA; or if aPageNode is not a page node
+   * @since Sitevision 2025.01.1
+   */
+  findPortletByContentIdentifier(
+    aPageNode: Node,
+    aContentIdentifier: String | string
+  ): Node;
+
   /**
    * Find a portlet with a specific name on a page node.
    *

package/server/NodeTreeUtil/index.js

@@ -9,6 +9,7 @@ var _default = exports["default"] = {
   getParent: function getParent() {},
   isDescendantOf: function isDescendantOf() {},
   getWebPathNodes: function getWebPathNodes() {},
+  findPortletByContentIdentifier: function findPortletByContentIdentifier() {},
   findPortletByName: function findPortletByName() {},
   findPortletsByName: function findPortletsByName() {},
   findPortletsByType: function findPortletsByType() {},

package/server/NodeTypeUtil/index.d.ts

@@ -1248,6 +1248,24 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    */
   METADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE: "sv:metadataMultipleTargetAudienceDefinition";
 
+  /**
+   * The primary node type name for the geolocation type
+   * @since Sitevision 2024.10.1
+   */
+  GEOLOCATION_TYPE: "sv:geolocation";
+
+  /**
+   * The primary node type name for the metadata geolocation definition type
+   * @since Sitevision 2024.10.1
+   */
+  METADATA_GEOLOCATION_DEFINITION_TYPE: "sv:metadataGeolocationDefinition";
+
+  /**
+   * The primary node type name for the metadata module definition type
+   * @since Sitevision 2025.01.1
+   */
+  METADATA_MODULE_DEFINITION_TYPE: "sv:metadataModuleDefinition";
+
   /**
    * Checks if a node is a layout.
    * @param aNode the node to be checked
@@ -1351,6 +1369,11 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    *     <li>The <em>Extractor</em> user (i.e. default "Web archive" user)</li>
    *     <li>The <em>Anonymized</em> user (i.e. an anonymized user)</li>
    *  </ul>
+   *
+   *  <p>
+   *     <em>Tip!</em> Use the {@link senselogic.sitevision.api.user.SystemUserUtil SystemUserUtil} utility to check
+   *     if a user is a specific build-in system user.
+   *  </p>
    * @param aNode the node to be checked
    * @return whether aNode is a {@link #SYSTEM_USER_TYPE sv:systemUser} or not.
    * @see #isAnyUserType(Node)
@@ -1607,6 +1630,8 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    *     <li>{@link #METADATA_SYSTEM_TEXT_DEFINITION_TYPE sv:metadataSystemTextDefinition}</li>
    *     <li>{@link #METADATA_SINGLE_TARGET_AUDIENCE_DEFINITION_TYPE sv:metadataSingleTargetAudienceDefinition}</li>
    *     <li>{@link #METADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE sv:metadataMultipleTargetAudienceDefinition}</li>
+   *     <li>{@link #METADATA_GEOLOCATION_DEFINITION_TYPE sv:metadataGeolocationDefinition}</li>
+   *     <li>{@link #METADATA_MODULE_DEFINITION_TYPE sv:metadataModuleDefinition}</li>
    *  </ul>
    * @param aNode the node to be checked
    * @return whether aNode is a "metadata definition node" or not.

package/server/SystemUserUtil/index.d.ts

@@ -5,7 +5,7 @@ import type { Node } from "../../types/javax/jcr/Node";
  *
  *  <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.
+ *     <em>Anonymous</em>, <em>System</em>, <em>Indexer</em>, <em>Validator</em> and <em>Extractor</em> user.
  *  </p>
  *
  *  <p>
@@ -17,6 +17,54 @@ import type { Node } from "../../types/javax/jcr/Node";
  * @since Sitevision 3.6
  */
 export interface SystemUserUtil {
+  /**
+   * Checks if current user is any system user (Anonymous, System, Indexer, Validator, Extractor).
+   *
+   *  <p>
+   *    This is a convenience method that is <strong>much more efficient</strong> than checking for each system user type instance separately.
+   *  </p>
+   *  <p>
+   *     Javascript code that uses <code>SystemUserUtil</code> like this:
+   *  </p><pre><code>const isLoggedInHuman = () =&gt; {
+   *    return (
+   *      !systemUserUtil.isAnonymous() &amp;&amp;
+   *      !systemUserUtil.isSystem() &amp;&amp;
+   *      !systemUserUtil.isIndexer() &amp;&amp;
+   *      !systemUserUtil.isValidator() &amp;&amp;
+   *      !systemUserUtil.isExtractor()
+   *    );
+   *  };</code></pre><p>
+   *     Should be replaced with code that uses this method instead:
+   *  </p><pre><code>const isLoggedInHuman = () =&gt; {
+   *    return !systemUserUtil.isAnySystemUser();
+   *  };</code></pre>
+   *
+   *  <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 returns true if the current user is any system user (Anonymous, System, Indexer, Validator, Extractor), false otherwise
+   * @see #isAnySystemUser(Node)
+   * @since Sitevision 2024.10.1
+   */
+  isAnySystemUser(): boolean;
+
+  /**
+   * Checks if a user node is any system user (Anonymous, System, Validator, Indexer, Extractor).
+   *
+   *  <p>
+   *     This is a convenience method that checks if a given user node is any system user
+   *     (Anonymous, System, Validator, Indexer, Extractor). Note that method is equivalent to checking the node <em>type</em>
+   *     via {@link senselogic.sitevision.api.node.NodeTypeUtil#isSystemUser(Node) NodeTypeUtil.isSystemUser(aUserNode)}.
+   *  </p>
+   * @param aUserNode a user node
+   * @return returns true if aUserNode is any system user (Anonymous, System, Validator, Indexer, Extractor), false otherwise
+   * @see senselogic.sitevision.api.node.NodeTypeUtil#isSystemUser(Node)
+   * @since Sitevision 2024.10.1
+   */
+  isAnySystemUser(aUserNode: Node): boolean;
+
   /**
    * Checks if current user is anonymous (not authenticated).
    *

package/server/SystemUserUtil/index.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = exports["default"] = {
+  isAnySystemUser: function isAnySystemUser() {},
   isAnonymous: function isAnonymous() {},
   isSystem: function isSystem() {},
   isIndexer: function isIndexer() {},

package/types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts

@@ -175,6 +175,11 @@ export type CollaborationGroupWrapper = Wrapper & {
    *     current user must also have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_CLOSED_COLLABORATION_GROUP}
    *     on the wrapped collaboration group.
    *  </p>
+   *  <p>
+   *     <strong>Note!</strong> Setting a group to <em>CLOSED</em> will break any potential permission inheritance for the group page of the group.
+   *     Hence the user that sets the group to {@link CollaborationGroupType#CLOSED} can potentially lose its permissions to access the (now closed)
+   *     group!
+   *  </p>
    * @param aCollaborationGroupType the collaboration group type
    * @since Sitevision 4.1
    */

package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts

@@ -1387,4 +1387,25 @@ export type NodeTypeUtilConstants = {
    * @since SiteVision 2024.09.2
    */
   getMETADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#GEOLOCATION_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#GEOLOCATION_TYPE}
+   * @since SiteVision 2024.10.1
+   */
+  getGEOLOCATION_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_GEOLOCATION_DEFINITION_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_GEOLOCATION_DEFINITION_TYPE}
+   * @since SiteVision 2024.10.1
+   */
+  getMETADATA_GEOLOCATION_DEFINITION_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_MODULE_DEFINITION_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_MODULE_DEFINITION_TYPE}
+   * @since SiteVision 2025.01.1
+   */
+  getMETADATA_MODULE_DEFINITION_TYPE(): string;
 };

package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js

@@ -205,5 +205,8 @@ var _default = exports["default"] = {
   getTARGET_AUDIENCE_TYPE: function getTARGET_AUDIENCE_TYPE() {},
   getTARGET_AUDIENCE_GROUP_TYPE: function getTARGET_AUDIENCE_GROUP_TYPE() {},
   getMETADATA_SINGLE_TARGET_AUDIENCE_DEFINITION_TYPE: function getMETADATA_SINGLE_TARGET_AUDIENCE_DEFINITION_TYPE() {},
-  getMETADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE: function getMETADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE() {}
+  getMETADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE: function getMETADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE() {},
+  getGEOLOCATION_TYPE: function getGEOLOCATION_TYPE() {},
+  getMETADATA_GEOLOCATION_DEFINITION_TYPE: function getMETADATA_GEOLOCATION_DEFINITION_TYPE() {},
+  getMETADATA_MODULE_DEFINITION_TYPE: function getMETADATA_MODULE_DEFINITION_TYPE() {}
 };