@sitevision/api 2024.9.2 → 2024.10.1

package/package.json

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

package/server/NodeTypeUtil/index.d.ts

@@ -1248,6 +1248,18 @@ 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";
+
   /**
    * Checks if a node is a layout.
    * @param aNode the node to be checked
@@ -1351,6 +1363,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 +1624,7 @@ 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>
    *  </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/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts

@@ -1387,4 +1387,18 @@ 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;
 };

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

@@ -205,5 +205,7 @@ 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() {}
 };