@sitevision/api 2023.2.1 → 2023.2.2-beta.2

package/server/PermissionUtil.Permission/index.js

@@ -5,34 +5,34 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
-  READ: 'READ',
-  WRITE: 'WRITE',
-  MOVE_NODE: 'MOVE_NODE',
-  PUBLISH: 'PUBLISH',
-  REVIEW: 'REVIEW',
-  DELETE: 'DELETE',
-  CREATE_ARCHIVE: 'CREATE_ARCHIVE',
-  CREATE_COLLABORATION_GROUP: 'CREATE_COLLABORATION_GROUP',
-  CREATE_FOLDER: 'CREATE_FOLDER',
-  CREATE_LAYOUT: 'CREATE_LAYOUT',
-  CREATE_PAGE: 'CREATE_PAGE',
-  CREATE_LINK_PAGE: 'CREATE_LINK_PAGE',
-  CREATE_CLOSED_COLLABORATION_GROUP: 'CREATE_CLOSED_COLLABORATION_GROUP',
-  MANAGE_COLLABORATION_GROUP: 'MANAGE_COLLABORATION_GROUP',
-  MANAGE_SITE_PROPERTIES: 'MANAGE_SITE_PROPERTIES',
-  MANAGE_SUBSCRIPTION: 'MANAGE_SUBSCRIPTION',
-  MANAGE_USER_IDENTITIES: 'MANAGE_USER_IDENTITIES',
-  MODIFY_SEARCH_PRIORITY: 'MODIFY_SEARCH_PRIORITY',
-  MANAGE_TRANSLATIONS: 'MANAGE_TRANSLATIONS',
-  MANAGE_ADDONS: 'MANAGE_ADDONS',
-  MANAGE_USERS: 'MANAGE_USERS',
-  MANAGE_RIGHTS: 'MANAGE_RIGHTS',
-  DEVELOPER: 'DEVELOPER',
-  USE_COLLABORATION_GROUP: 'USE_COLLABORATION_GROUP',
-  MANAGE_TOPICS: 'MANAGE_TOPICS',
-  MANAGE_PUBLISHING_PROJECT: 'MANAGE_PUBLISHING_PROJECT',
-  MANAGE_DOWNLOAD_PROTECTION: 'MANAGE_DOWNLOAD_PROTECTION',
-  MANAGE_CHANNELS: 'MANAGE_CHANNELS',
-  CREATE_PRIVATE_CHANNELS: 'CREATE_PRIVATE_CHANNELS'
+  READ: "READ",
+  WRITE: "WRITE",
+  MOVE_NODE: "MOVE_NODE",
+  PUBLISH: "PUBLISH",
+  REVIEW: "REVIEW",
+  DELETE: "DELETE",
+  CREATE_ARCHIVE: "CREATE_ARCHIVE",
+  CREATE_COLLABORATION_GROUP: "CREATE_COLLABORATION_GROUP",
+  CREATE_FOLDER: "CREATE_FOLDER",
+  CREATE_LAYOUT: "CREATE_LAYOUT",
+  CREATE_PAGE: "CREATE_PAGE",
+  CREATE_LINK_PAGE: "CREATE_LINK_PAGE",
+  CREATE_CLOSED_COLLABORATION_GROUP: "CREATE_CLOSED_COLLABORATION_GROUP",
+  MANAGE_COLLABORATION_GROUP: "MANAGE_COLLABORATION_GROUP",
+  MANAGE_SITE_PROPERTIES: "MANAGE_SITE_PROPERTIES",
+  MANAGE_SUBSCRIPTION: "MANAGE_SUBSCRIPTION",
+  MANAGE_USER_IDENTITIES: "MANAGE_USER_IDENTITIES",
+  MODIFY_SEARCH_PRIORITY: "MODIFY_SEARCH_PRIORITY",
+  MANAGE_TRANSLATIONS: "MANAGE_TRANSLATIONS",
+  MANAGE_ADDONS: "MANAGE_ADDONS",
+  MANAGE_USERS: "MANAGE_USERS",
+  MANAGE_RIGHTS: "MANAGE_RIGHTS",
+  DEVELOPER: "DEVELOPER",
+  USE_COLLABORATION_GROUP: "USE_COLLABORATION_GROUP",
+  MANAGE_TOPICS: "MANAGE_TOPICS",
+  MANAGE_PUBLISHING_PROJECT: "MANAGE_PUBLISHING_PROJECT",
+  MANAGE_DOWNLOAD_PROTECTION: "MANAGE_DOWNLOAD_PROTECTION",
+  MANAGE_CHANNELS: "MANAGE_CHANNELS",
+  CREATE_PRIVATE_CHANNELS: "CREATE_PRIVATE_CHANNELS"
 };
 exports["default"] = _default;

package/server/PortletContextUtil/index.d.ts

@@ -1,19 +1,21 @@
 import type { Node } from "../../types/javax/jcr/Node";
+import type { Locale } from "../../types/java/util/Locale";
 
+import type { String } from "../../types/java/lang/String";
 import type { PortletContextUtilConstants } from "../../types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants";
 
 /**
  * Portlet context utility interface.
  *
- * <p>
- *    Contains methods for retrieving information about present portlet execution context.
- * </p>
+ *  <p>
+ *     Contains methods for retrieving information about present portlet execution context.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getPortletContextUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.Utils#getPortletContextUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  */
 export interface PortletContextUtil extends PortletContextUtilConstants {
@@ -31,7 +33,7 @@ export interface PortletContextUtil extends PortletContextUtilConstants {
 
   /**
    * Gets current page (i.e. the page node for the currently executing portlet).
-   * @return current page <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet or current portlet is not bound to any page)
+   * @return current page <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet or&#xA; current portlet is not bound to any page)
    */
   getCurrentPage(): Node;
 
@@ -43,7 +45,7 @@ export interface PortletContextUtil extends PortletContextUtilConstants {
 
   /**
    * Gets current module element (module element draft or module element).
-   * @return current module element as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a module element)
+   * @return current module element as <code>Node</code>, or <code>null</code> if indeterminable&#xA; (i.e. this method is not called from within a module element)
    * @since Sitevision 4.2
    */
   getCurrentModuleElement(): Node;
@@ -53,7 +55,7 @@ export interface PortletContextUtil extends PortletContextUtilConstants {
    * @return current <code>Locale</code>, or default <code>Locale</code> if indeterminable
    * @see senselogic.sitevision.api.node.NodeResolverUtil#getLocaleResolver()
    */
-  getCurrentLocale(): unknown;
+  getCurrentLocale(): Locale;
 
   /**
    * Gets current user.
@@ -72,10 +74,10 @@ export interface PortletContextUtil extends PortletContextUtilConstants {
   /**
    * Gets current decorated node (applicable during render of a sv:decorationTemplate).
    *
-   * <p>
-   *    This method returns the "decorated" node (typically a sv:portlet or sv:layout) during render of a sv:decorationTemplate.
-   *    In other words - it returns the node that is decorated with the template-based decoration that is now rendering.
-   * </p>
+   *  <p>
+   *     This method returns the "decorated" node (typically a sv:portlet or sv:layout) during render of a sv:decorationTemplate.
+   *     In other words - it returns the node that is decorated with the template-based decoration that is now rendering.
+   *  </p>
    * @return the decorated node or null if indeterminable (i.e. the caller is not a part of a decoration template that is being rendered right now)
    * @since Sitevision 5.1
    */
@@ -83,7 +85,7 @@ export interface PortletContextUtil extends PortletContextUtilConstants {
 
   /**
    * Gets current version.
-   * @return {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}, or {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+   * @return {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}, or&#xA; {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
    * @since Sitevision 2.6
    * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#getCurrentVersion()}
    */
@@ -92,30 +94,30 @@ export interface PortletContextUtil extends PortletContextUtilConstants {
   /**
    * Gets a unique namespace for the specific portlet that is rendering.
    *
-   * <p>
-   *    The namespace is based on the prefix (aPrefix) and the current portlet's id.
-   *    If you have two portlets of same type on the same page, the namespaces will differ. This can for instance be very useful when you
-   *    connect a &lt;label&gt; with an &lt;input&gt;. Example in Velocity:
-   * </p>
-   * <pre><code>
-   *   #set ($portletContextUtil = $sitevisionUtils.portletContextUtil)
-   *   ...
-   *   #set ($ns = $portletContextUtil.getPortletNamespace('name'))
-   *   &lt;label for="$ns"&gt;Name: &lt;/label&gt;&lt;input id="$ns" name="name" type="text" /&gt;</code></pre>
-   * The namespace generated in the above example (i.e. <code>$ns</code>) could be something like: <code>name12_2b9561c511855e0ab91800015</code>
+   *  <p>
+   *     The namespace is based on the prefix (aPrefix) and the current portlet's id.
+   *     If you have two portlets of same type on the same page, the namespaces will differ. This can for instance be very useful when you
+   *     connect a &lt;label&gt; with an &lt;input&gt;. Example in Velocity:
+   *  </p>
+   *  <pre><code>
+   *    #set ($portletContextUtil = $sitevisionUtils.portletContextUtil)
+   *    ...
+   *    #set ($ns = $portletContextUtil.getPortletNamespace('name'))
+   *    &lt;label for="$ns"&gt;Name: &lt;/label&gt;&lt;input id="$ns" name="name" type="text" /&gt;</code></pre>
+   *  The namespace generated in the above example (i.e. <code>$ns</code>) could be something like: <code>name12_2b9561c511855e0ab91800015</code>
    * @param aPrefix the prefix for the namespace (ensure it only contains chars that are valid in an id value if you use it as such)
    * @return a unique prefixed namespace for current portlet, or aPrefix if indeterminable
    */
-  getPortletNamespace(aPrefix: string): string;
+  getPortletNamespace(aPrefix: String | string): string;
 
   /**
    * Gets a unique nonce for this request.
    *
-   * <p>
-   *    The nonce should be used for all client-side inline javascript (e.g. <code>&lt;script nonce="..."&gt; ... &lt;script&gt;</code>).
-   *    If not specified, the script might be blocked and ignored by the client/browser due to the content security policy settings of the page
-   *    (i.e. typically when the CSP has no "unsafe-inline" specified).
-   * </p>
+   *  <p>
+   *     The nonce should be used for all client-side inline javascript (e.g. <code>&lt;script nonce="..."&gt; ... &lt;script&gt;</code>).
+   *     If not specified, the script might be blocked and ignored by the client/browser due to the content security policy settings of the page
+   *     (i.e. typically when the CSP has no "unsafe-inline" specified).
+   *  </p>
    * @return A unique identifier for this request.
    * @since Sitevision 2022.08.1
    */

package/server/PortletUtil/index.d.ts

@@ -5,10 +5,10 @@ import type { PortletUtilConstants } from "../../types/senselogic/sitevision/api
 /**
  * <p>Portlet utility interface.</p>
  *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPortletUtil()}.
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *  An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPortletUtil()}.
+ *  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_06
  */
@@ -21,15 +21,15 @@ export interface PortletUtil extends PortletUtilConstants {
 
   /**
    * <p>Extracts the user specific <code>PortletPreferences</code> for the specified portlet.
-   * This method is a complement to the accessor provided by <code>PortletRequest.getPreferences</code>
-   * which returns the <code>PortletPreferences</code> for the current user.</p>
+   *  This method is a complement to the accessor provided by <code>PortletRequest.getPreferences</code>
+   *  which returns the <code>PortletPreferences</code> for the current user.</p>
    *
-   * <p>Note that this method only returns the portlet preferences that are stored. Any
-   * local modifications that has not yet been stored will be ignored.</p>
+   *  <p>Note that this method only returns the portlet preferences that are stored. Any
+   *  local modifications that has not yet been stored will be ignored.</p>
    * @param portlet The <code>Node</code> corresponding to a portlet
    * @param user The <code>Node</code> corresponding to a user
    * @param portletPreferencesType The preferences type <em>(for now, only {@link #PORTLET_PREFERENCES_TYPE_USER} is allowed)</em>
-   * @return <code>PortletPreferences</code> that is effective for the provided user for the specified portlet
+   * @return <code>PortletPreferences</code> that is effective for the provided user for&#xA; the specified portlet
    */
   getPortletPreferences(
     portlet: Node,

package/server/PrincipalUtil/index.d.ts

@@ -1,12 +1,16 @@
 import type { Node } from "../../types/javax/jcr/Node";
+import type { PrivilegedExceptionAction } from "../../types/java/security/PrivilegedExceptionAction";
+
+import type { String } from "../../types/java/lang/String";
+import type { List } from "../../types/java/util/List";
 
 /**
  * <p>Principal utility interface.</p>
  *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPrincipalUtil()}.
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *  An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPrincipalUtil()}.
+ *  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_06
  */
@@ -14,15 +18,15 @@ export interface PrincipalUtil {
   /**
    * Perform work during the login phase as a specified user.
    *
-   * <p>
-   *    <strong>Note!</strong> This method should <em>only</em> be used during the login phase (i.e. in a JAAS login module).
-   *    Other usages will throw an <code>IllegalStateException</code>.
-   * </p>
+   *  <p>
+   *     <strong>Note!</strong> This method should <em>only</em> be used during the login phase (i.e. in a JAAS login module).
+   *     Other usages will throw an <code>IllegalStateException</code>.
+   *  </p>
    * @param aUser the user
    * @param aAction a runnable containing the operations that is to be performed
    * @throws IllegalStateException if this method is not called during the login phase
    */
-  doAsDuringLogin(aUser: Node, aAction: unknown): void;
+  doAsDuringLogin(aUser: Node, aAction: PrivilegedExceptionAction): void;
 
   /**
    * Provides access to a virtual group wrapped as a JCR node given the group name.
@@ -30,7 +34,7 @@ export interface PrincipalUtil {
    * @return the virtual group wrapped in a JCR node, or null if none exists
    * @since Sitevision 3.0
    */
-  getVirtualGroupByName(aName: string): Node;
+  getVirtualGroupByName(aName: String | string): Node;
 
   /**
    * Provides access to virtual groups wrapped as a JCR node given the group name.
@@ -38,7 +42,7 @@ export interface PrincipalUtil {
    * @return a list of virtual groups wrapped in JCR nodes, or an empty list of none exists
    * @since Sitevision 3.0
    */
-  getVirtualGroupsByName(aNames: unknown): unknown;
+  getVirtualGroupsByName(aNames: List | unknown[]): List;
 }
 
 declare namespace PrincipalUtil {}

package/server/Properties/index.d.ts

@@ -1,97 +1,100 @@
+import type { Object } from "../../types/java/lang/Object";
+import type { String } from "../../types/java/lang/String";
+
 /**
  * Utility interface for getting multiple Node property values in server-side Javascript.
  *
- * <p>
- *    Extraction of property values from Nodes are typically performed using {@link PropertyUtil}
- *    but this utility is less obtrusive to work with in server-side script contexts (WebApps, RESTApps, Script module etc.).
- * </p>
- * <p>
- *    <strong>Property value types</strong><br>
- *    The value of a JCR Node property can be resolved as different types.
- *    For instance a property with primary type {@link javax.jcr.PropertyType#DATE} can be resolved as {@code Calendar} or as {@code String}.
- *    This utility returns values with a specific type:
- * </p>
- * <ul>
- *    <li>The numerical <em>timestamp</em> will be returned as value for properties of type {@link javax.jcr.PropertyType#DATE}.</li>
- *    <li>The Node <em>identifier</em> will be returned as value for properties of type {@link javax.jcr.PropertyType#WEAKREFERENCE}.</li>
- * </ul>
+ *  <p>
+ *     Extraction of property values from Nodes are typically performed using {@link PropertyUtil}
+ *     but this utility is less obtrusive to work with in server-side script contexts (WebApps, RESTApps, Script module etc.).
+ *  </p>
+ *  <p>
+ *     <strong>Property value types</strong><br>
+ *     The value of a JCR Node property can be resolved as different types.
+ *     For instance a property with primary type {@link javax.jcr.PropertyType#DATE} can be resolved as {@code Calendar} or as {@code String}.
+ *     This utility returns values with a specific type:
+ *  </p>
+ *  <ul>
+ *     <li>The numerical <em>timestamp</em> will be returned as value for properties of type {@link javax.jcr.PropertyType#DATE}.</li>
+ *     <li>The Node <em>identifier</em> will be returned as value for properties of type {@link javax.jcr.PropertyType#WEAKREFERENCE}.</li>
+ *  </ul>
  *
- * <p>
- *    <strong>Example</strong><br>
- *    Below is an example that demonstrates the behaviour and usage of this utility.
- * </p><pre>   <strong>var</strong> properties = require('Properties');
- *   <em>...</em>
+ *  <p>
+ *     <strong>Example</strong><br>
+ *     Below is an example that demonstrates the behaviour and usage of this utility.
+ *  </p><pre>   <strong>var</strong> properties = require('Properties');
+ *    <em>...</em>
  *
- *   <em><strong>// get examples</strong></em>
+ *    <em><strong>// get examples</strong></em>
  *
- *   <em>// Returns the identifier of the given Node, e.g: '4.540818ed12a6539aa3f80001645'</em>
- *   pageId = properties.get(pageNode);
+ *    <em>// Returns the identifier of the given Node, e.g: '4.540818ed12a6539aa3f80001645'</em>
+ *    pageId = properties.get(pageNode);
  *
- *   <em>// Returns the URI property value of the given Node, e.g. '/4.540818ed12a6539aa3f80001645.html'</em>
- *   pageUri = properties.get(pageNode, 'URI');
+ *    <em>// Returns the URI property value of the given Node, e.g. '/4.540818ed12a6539aa3f80001645.html'</em>
+ *    pageUri = properties.get(pageNode, 'URI');
  *
- *   <em>// Returns the displayName property value of the given Node, e.g. 'The page'</em>
- *   pageName = properties.get(pageNode, 'displayName');
- *   pageName = properties.get(pageId, 'displayName');
- *   pageName = properties.get(pageUri, 'displayName');
+ *    <em>// Returns the displayName property value of the given Node, e.g. 'The page'</em>
+ *    pageName = properties.get(pageNode, 'displayName');
+ *    pageName = properties.get(pageId, 'displayName');
+ *    pageName = properties.get(pageUri, 'displayName');
  *
- *   <em>// Returns a native script object with given properties (that exist) of the specified Node e.g:
- *   // {
- *   //    URI: '/4.540818ed12a6539aa3f80001645.html',
- *   //    displayName: 'The page',
- *   //    published: true,
- *   //    publishDate: 1227618333142
- *   // }</em>
- *   pageData = properties.get(pageNode, 'URI', 'displayName', 'published', 'publishDate', 'nameOfNonExistingProperty');
+ *    <em>// Returns a native script object with given properties (that exist) of the specified Node e.g:
+ *    // {
+ *    //    URI: '/4.540818ed12a6539aa3f80001645.html',
+ *    //    displayName: 'The page',
+ *    //    published: true,
+ *    //    publishDate: 1227618333142
+ *    // }</em>
+ *    pageData = properties.get(pageNode, 'URI', 'displayName', 'published', 'publishDate', 'nameOfNonExistingProperty');
  *
- *   <em><strong>// getArray examples</strong></em>
+ *    <em><strong>// getArray examples</strong></em>
  *
- *   <em>// Returns the identifier of the given Node as array, e.g: ['4.540818ed12a6539aa3f80001645']</em>
- *   pageIdArray = properties.getArray(pageNode);
+ *    <em>// Returns the identifier of the given Node as array, e.g: ['4.540818ed12a6539aa3f80001645']</em>
+ *    pageIdArray = properties.getArray(pageNode);
  *
- *   <em>// Returns the identifier for the children of given Node as array, e.g:
- *   // [
- *   //    '19.540818ed12a6539aa3f80006889',
- *   //    '4.540818ed12a6539aa3f80001645_pageContent',
- *   //    ...
- *   // ]</em>
- *   childIdsArray = properties.getArray(pageNode.getNodes());
+ *    <em>// Returns the identifier for the children of given Node as array, e.g:
+ *    // [
+ *    //    '19.540818ed12a6539aa3f80006889',
+ *    //    '4.540818ed12a6539aa3f80001645_pageContent',
+ *    //    ...
+ *    // ]</em>
+ *    childIdsArray = properties.getArray(pageNode.getNodes());
  *
- *   <em>// Returns the displayName for the nodes of a menu from a given Node as array, e.g:
- *   // [
- *   //    'The Page',
- *   //    'Another Page',
- *   //    ...
- *   // ]</em>
- *   menuNamesArray = properties.getArray(nodeIteratorUtil.getMenuItems(pageNode), 'displayName');
+ *    <em>// Returns the displayName for the nodes of a menu from a given Node as array, e.g:
+ *    // [
+ *    //    'The Page',
+ *    //    'Another Page',
+ *    //    ...
+ *    // ]</em>
+ *    menuNamesArray = properties.getArray(nodeIteratorUtil.getMenuItems(pageNode), 'displayName');
  *
- *   <em>// Returns the displayName and URI for the hits of a SearchResult as array, e.g:
- *   // [
- *   //    {
- *   //       displayName: 'Public API'
- *   //       URI: '/docs/public-api',
- *   //    },
- *   //    {
- *   //       displayName: 'REST API'
- *   //       URI: '/docs/rest-api',
- *   //    },
- *   //    ...
- *   // ]</em>
- *   hitsDataArray = properties.getArray(searchResult, 'displayName', 'URI');</pre>
+ *    <em>// Returns the displayName and URI for the hits of a SearchResult as array, e.g:
+ *    // [
+ *    //    {
+ *    //       displayName: 'Public API'
+ *    //       URI: '/docs/public-api',
+ *    //    },
+ *    //    {
+ *    //       displayName: 'REST API'
+ *    //       URI: '/docs/rest-api',
+ *    //    },
+ *    //    ...
+ *    // ]</em>
+ *    hitsDataArray = properties.getArray(searchResult, 'displayName', 'URI');</pre>
  *
- * <p>
- *    <strong>Security reminder! All output should always be escaped to prevent XSS!</strong>
- * </p>
- * <ul>
- *    <li>
- *       When implementing a WebApp, you would typically use {@link #get(Object, String...)} or {@link #getArray(Object, String...)}
- *       and output the value with underscore escape (e.g. <code>&lt;%- theValueToEscape %&gt;</code>).
- *    </li>
- *    <li>
- *       In other server-side scripting contexts (e.g. the Script module) you would typically use {@link #getEscaped(Object, String...)} or
- *       {@link #getArrayEscaped(Object, String...)} and output the (already) escaped value using Velocity (e.g. <code>$theEscapedValue</code>).
- *    </li>
- * </ul>
+ *  <p>
+ *     <strong>Security reminder! All output should always be escaped to prevent XSS!</strong>
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        When implementing a WebApp, you would typically use {@link #get(Object, String...)} or {@link #getArray(Object, String...)}
+ *        and output the value with underscore escape (e.g. <code>&lt;%- theValueToEscape %&gt;</code>).
+ *     </li>
+ *     <li>
+ *        In other server-side scripting contexts (e.g. the Script module) you would typically use {@link #getEscaped(Object, String...)} or
+ *        {@link #getArrayEscaped(Object, String...)} and output the (already) escaped value using Velocity (e.g. <code>$theEscapedValue</code>).
+ *     </li>
+ *  </ul>
  * @param <T> native script value
  * @author Magnus Lövgren
  * @since Sitevision 4.5.2
@@ -100,44 +103,47 @@ export interface Properties {
   /**
    * Gets named properties from a given Node-resolvable object.
    *
-   * <p>
-   *    <em>See code examples in the interface description above.</em>
-   * </p>
-   * @param aJcrNodeResolvable something that can be resolved as a Node. Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
+   *  <p>
+   *     <em>See code examples in the interface description above.</em>
+   *  </p>
+   * @param aJcrNodeResolvable something that can be resolved as a Node.&#xA; Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
    * @param aPropertyNames the names of the properties of interest
    * @return the properties as a native Javascript object
    * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
    * @see #getEscaped(Object, String...)
    */
-  get(aJcrNodeResolvable: unknown, aPropertyNames: string): unknown;
+  get(aJcrNodeResolvable: unknown, aPropertyNames: String | string[]): unknown;
 
   /**
    * Gets escaped named properties from a given Node-resolvable object.
    *
-   * <p>
-   *    This method is equivalent with {@link #get(Object, String...)} except that all string values will be escaped.
-   * </p>
-   * @param aJcrNodeResolvable something that can be resolved as a Node. Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
+   *  <p>
+   *     This method is equivalent with {@link #get(Object, String...)} except that all string values will be escaped.
+   *  </p>
+   * @param aJcrNodeResolvable something that can be resolved as a Node.&#xA; Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
    * @param aPropertyNames the names of the properties of interest
    * @return the escaped properties as a native Javascript object
    * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
    * @since Sitevision 6.2
    */
-  getEscaped(aJcrNodeResolvable: unknown, aPropertyNames: string): unknown;
+  getEscaped(
+    aJcrNodeResolvable: unknown,
+    aPropertyNames: String | string[]
+  ): unknown;
 
   /**
    * Processes an iterable object and returns an array of named properties for each Node-resolvable object that is iterated.
    *
-   * <p>
-   *    This method is conceptually equivalent with the {@link #get(Object, String...) get} method but
-   *    the core functionality of this method is to process something that can be iterated in order to handle <em>multiple</em> nodes
-   *    and deliver properties for them as an array.
-   * </p>
+   *  <p>
+   *     This method is conceptually equivalent with the {@link #get(Object, String...) get} method but
+   *     the core functionality of this method is to process something that can be iterated in order to handle <em>multiple</em> nodes
+   *     and deliver properties for them as an array.
+   *  </p>
    *
-   * <p>
-   *    <em>See code examples in the interface description above.</em>
-   * </p>
-   * @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult}, {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit} (the <em>accepted</em> nodes will be processed)
+   *  <p>
+   *     <em>See code examples in the interface description above.</em>
+   *  </p>
+   * @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved&#xA; as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult},&#xA; {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit}&#xA; (the <em>accepted</em> nodes will be processed)
    * @param aPropertyNames the names of the properties of interest
    * @return a native Javascript array with properties
    * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
@@ -145,21 +151,24 @@ export interface Properties {
    * @see #getArrayEscaped(Object, String...)
    * @since Sitevision 6.1
    */
-  getArray(aIterable: unknown, aPropertyNames: string): unknown;
+  getArray(aIterable: unknown, aPropertyNames: String | string[]): unknown;
 
   /**
    * Processes an iterable object and returns an array of escaped named properties for each Node-resolvable object that is iterated.
    *
-   * <p>
-   *    This method is equivalent with {@link #getArray(Object, String...)} except that all string values will be escaped.
-   * </p>
-   * @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult}, {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit} (the <em>accepted</em> nodes will be processed)
+   *  <p>
+   *     This method is equivalent with {@link #getArray(Object, String...)} except that all string values will be escaped.
+   *  </p>
+   * @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved&#xA; as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult},&#xA; {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit}&#xA; (the <em>accepted</em> nodes will be processed)
    * @param aPropertyNames the names of the properties of interest
    * @return a native Javascript array with escaped properties
    * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
    * @since Sitevision 6.2
    */
-  getArrayEscaped(aIterable: unknown, aPropertyNames: string): unknown;
+  getArrayEscaped(
+    aIterable: unknown,
+    aPropertyNames: String | string[]
+  ): unknown;
 }
 
 declare namespace Properties {}