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

package/server/PermissionUtil.Permission/index.d.ts

@@ -0,0 +1,54 @@
+/**
+ * The named permission demarcation, used by {@link PermissionUtil}.
+ *
+ * <p>
+ *    Example of how to get the {@link #READ} type:
+ * </p>
+ * <ul>
+ *    <li>
+ *       Using <strong>Velocity:</strong><pre><code>
+ *       #set ($instanceCreatorUtil = $sitevisionUtils.instanceCreatorUtil)
+ *       #set ($enumClassName = 'senselogic.sitevision.api.security.PermissionUtil$Permission') <em>## Note the '$' separator...</em>
+ *       #set ($readEnum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'READ'))</code></pre>
+ *    </li>
+ *    <li>
+ *       Using server-side <strong>JavaScript:</strong><pre><code>
+ *       var readEnum = require('PermissionUtil.Permission.READ');</code></pre>
+ *    </li>
+ * </ul>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+declare enum Permission {
+  READ,
+  WRITE,
+  MOVE_NODE,
+  PUBLISH,
+  REVIEW,
+  DELETE,
+  CREATE_ARCHIVE,
+  CREATE_COLLABORATION_GROUP,
+  CREATE_FOLDER,
+  CREATE_LAYOUT,
+  CREATE_PAGE,
+  CREATE_LINK_PAGE,
+  CREATE_CLOSED_COLLABORATION_GROUP,
+  MANAGE_COLLABORATION_GROUP,
+  MANAGE_SITE_PROPERTIES,
+  MANAGE_SUBSCRIPTION,
+  MANAGE_USER_IDENTITIES,
+  MODIFY_SEARCH_PRIORITY,
+  MANAGE_TRANSLATIONS,
+  MANAGE_ADDONS,
+  MANAGE_USERS,
+  MANAGE_RIGHTS,
+  DEVELOPER,
+  USE_COLLABORATION_GROUP,
+  MANAGE_TOPICS,
+  MANAGE_PUBLISHING_PROJECT,
+  MANAGE_DOWNLOAD_PROTECTION,
+  MANAGE_CHANNELS,
+  CREATE_PRIVATE_CHANNELS,
+}
+
+export default Permission;

package/server/PermissionUtil.Permission/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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'
+};
+exports["default"] = _default;

package/server/PortletContextUtil/index.d.ts

@@ -1,96 +1,6 @@
-import Node from "../../hidden/javax/jcr/Node";
+import type Node from "../../types/javax/jcr/Node";
 
-/**
- * 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)
- */
-export function getCurrentPage(): Node;
-
-/**
- * Gets current portlet.
- * @return current portlet as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet)
- */
-export function getCurrentPortlet(): Node;
-
-/**
- * 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)
- * @since Sitevision 4.2
- */
-export function getCurrentModuleElement(): Node;
-
-/**
- * Gets current Locale.
- * @return current <code>Locale</code>, or default <code>Locale</code> if indeterminable
- * @see senselogic.sitevision.api.node.NodeResolverUtil#getLocaleResolver()
- */
-export function getCurrentLocale(): unknown;
-
-/**
- * Gets current user.
- * @return current user <code>Node</code>, or <code>null</code> if indeterminable
- * @since Sitevision 2.6
- */
-export function getCurrentUser(): Node;
-
-/**
- * Gets current user identity.
- * @return current user identity <code>Node</code>, or <code>null</code> if indeterminable
- * @since Sitevision 3.5
- */
-export function getCurrentUserIdentity(): Node;
-
-/**
- * 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>
- * @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
- */
-export function getCurrentDecoratedNode(): Node;
-
-/**
- * Gets current version.
- * @return {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}, or {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
- * @since Sitevision 2.6
- * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#getCurrentVersion()}
- */
-export function getCurrentVersion(): number;
-
-/**
- * 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>
- * @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
- */
-export function getPortletNamespace(aPrefix: 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>
- * @return A unique identifier for this request.
- * @since Sitevision 2022.08.1
- */
-export function getNonce(): string;
+import type PortletContextUtilConstants from "../../types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants";
 
 /**
  * Portlet context utility interface.
@@ -103,24 +13,117 @@ export function getNonce(): string;
  *    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>The offline version (i.e. the version used when editing in the Sitevision editor) markerThe online version (i.e. the published version that visitors can access) marker
+ * </p>
  * @author Magnus Lövgren
- * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}
- * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
  */
-declare namespace portletContextUtil {
-  export {
-    getCurrentPage,
-    getCurrentPortlet,
-    getCurrentModuleElement,
-    getCurrentLocale,
-    getCurrentUser,
-    getCurrentUserIdentity,
-    getCurrentDecoratedNode,
-    getCurrentVersion,
-    getPortletNamespace,
-    getNonce,
-  };
+export interface PortletContextUtil extends PortletContextUtilConstants {
+  /**
+   * The offline version (i.e. the version used when editing in the Sitevision editor) marker
+   * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}
+   */
+  OFFLINE_VERSION: 0;
+
+  /**
+   * The online version (i.e. the published version that visitors can access) marker
+   * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+   */
+  ONLINE_VERSION: 1;
+
+  /**
+   * 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)
+   */
+  getCurrentPage(): Node;
+
+  /**
+   * Gets current portlet.
+   * @return current portlet as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet)
+   */
+  getCurrentPortlet(): Node;
+
+  /**
+   * 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)
+   * @since Sitevision 4.2
+   */
+  getCurrentModuleElement(): Node;
+
+  /**
+   * Gets current Locale.
+   * @return current <code>Locale</code>, or default <code>Locale</code> if indeterminable
+   * @see senselogic.sitevision.api.node.NodeResolverUtil#getLocaleResolver()
+   */
+  getCurrentLocale(): unknown;
+
+  /**
+   * Gets current user.
+   * @return current user <code>Node</code>, or <code>null</code> if indeterminable
+   * @since Sitevision 2.6
+   */
+  getCurrentUser(): Node;
+
+  /**
+   * Gets current user identity.
+   * @return current user identity <code>Node</code>, or <code>null</code> if indeterminable
+   * @since Sitevision 3.5
+   */
+  getCurrentUserIdentity(): Node;
+
+  /**
+   * 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>
+   * @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
+   */
+  getCurrentDecoratedNode(): Node;
+
+  /**
+   * Gets current version.
+   * @return {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}, or {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+   * @since Sitevision 2.6
+   * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#getCurrentVersion()}
+   */
+  getCurrentVersion(): number;
+
+  /**
+   * 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>
+   * @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;
+
+  /**
+   * 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>
+   * @return A unique identifier for this request.
+   * @since Sitevision 2022.08.1
+   */
+  getNonce(): string;
 }
 
-export default portletContextUtil;
+declare namespace PortletContextUtil {}
+
+declare var portletContextUtil: PortletContextUtil;
+
+export = portletContextUtil;

package/server/PortletUtil/index.d.ts

@@ -1,22 +1,6 @@
-import Node from "../../hidden/javax/jcr/Node";
+import type Node from "../../types/javax/jcr/Node";
 
-/**
- * <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>
- *
- * <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
- */
-export function getPortletPreferences(
-  portlet: Node,
-  user: Node,
-  portletPreferencesType: number
-): unknown;
+import type PortletUtilConstants from "../../types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants";
 
 /**
  * <p>Portlet utility interface.</p>
@@ -24,12 +8,38 @@ export function getPortletPreferences(
  * <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>The personal portlet preferences type.
+ * </p>
  * @author Mikael Wikblom
  * @since Sitevision 2.6_06
  */
-declare namespace portletUtil {
-  export { getPortletPreferences };
+export interface PortletUtil extends PortletUtilConstants {
+  /**
+ * The personal portlet preferences type.
+  
+    */
+  PORTLET_PREFERENCES_TYPE_USER: 11;
+
+  /**
+   * <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>
+   *
+   * <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
+   */
+  getPortletPreferences(
+    portlet: Node,
+    user: Node,
+    portletPreferencesType: number
+  ): unknown;
 }
 
-export default portletUtil;
+declare namespace PortletUtil {}
+
+declare var portletUtil: PortletUtil;
+
+export = portletUtil;

package/server/PrincipalUtil/index.d.ts

@@ -1,33 +1,4 @@
-import Node from "../../hidden/javax/jcr/Node";
-
-/**
- * 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>
- * @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
- */
-export function doAsDuringLogin(aUser: Node, aAction: unknown): void;
-
-/**
- * Provides access to a virtual group wrapped as a JCR node given the group name.
- * @param aName the name of the virtual group, may not be null
- * @return the virtual group wrapped in a JCR node, or null if none exists
- * @since Sitevision 3.0
- */
-export function getVirtualGroupByName(aName: string): Node;
-
-/**
- * Provides access to virtual groups wrapped as a JCR node given the group name.
- * @param aNames a list of names, may not be null
- * @return a list of virtual groups wrapped in JCR nodes, or an empty list of none exists
- * @since Sitevision 3.0
- */
-export function getVirtualGroupsByName(aNames: unknown): unknown;
+import type Node from "../../types/javax/jcr/Node";
 
 /**
  * <p>Principal utility interface.</p>
@@ -39,8 +10,39 @@ export function getVirtualGroupsByName(aNames: unknown): unknown;
  * @author Mikael Wikblom
  * @since Sitevision 2.6.1_06
  */
-declare namespace principalUtil {
-  export { doAsDuringLogin, getVirtualGroupByName, getVirtualGroupsByName };
+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>
+   * @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;
+
+  /**
+   * Provides access to a virtual group wrapped as a JCR node given the group name.
+   * @param aName the name of the virtual group, may not be null
+   * @return the virtual group wrapped in a JCR node, or null if none exists
+   * @since Sitevision 3.0
+   */
+  getVirtualGroupByName(aName: string): Node;
+
+  /**
+   * Provides access to virtual groups wrapped as a JCR node given the group name.
+   * @param aNames a list of names, may not be null
+   * @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;
 }
 
-export default principalUtil;
+declare namespace PrincipalUtil {}
+
+declare var principalUtil: PrincipalUtil;
+
+export = principalUtil;

package/server/Properties/index.d.ts

@@ -1,76 +1,3 @@
-/**
- * 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)
- * @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...)
- */
-export function get(
-  aJcrNodeResolvable: unknown,
-  aPropertyNames: 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)
- * @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
- */
-export function getEscaped(
-  aJcrNodeResolvable: unknown,
-  aPropertyNames: 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>
- *    <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)
- * @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
- * @see senselogic.sitevision.api.node.NodeIteratorUtil
- * @see #getArrayEscaped(Object, String...)
- * @since Sitevision 6.1
- */
-export function getArray(aIterable: unknown, aPropertyNames: 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)
- * @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
- */
-export function getArrayEscaped(
-  aIterable: unknown,
-  aPropertyNames: string
-): unknown;
-
 /**
  * Utility interface for getting multiple Node property values in server-side Javascript.
  *
@@ -169,8 +96,74 @@ export function getArrayEscaped(
  * @author Magnus Lövgren
  * @since Sitevision 4.5.2
  */
-declare namespace properties {
-  export { get, getEscaped, getArray, getArrayEscaped };
+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)
+   * @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;
+
+  /**
+   * 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)
+   * @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;
+
+  /**
+   * 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>
+   *    <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)
+   * @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
+   * @see senselogic.sitevision.api.node.NodeIteratorUtil
+   * @see #getArrayEscaped(Object, String...)
+   * @since Sitevision 6.1
+   */
+  getArray(aIterable: unknown, aPropertyNames: 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)
+   * @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;
 }
 
-export default properties;
+declare namespace Properties {}
+
+declare var properties: Properties;
+
+export = properties;