@sitevision/api 2.0.0-alpha.1 → 2023.2.1-alpha.0

package/server/UserFieldRenderer/index.d.ts

@@ -1,121 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * Updates the renderer with a new user identity node.
- *
- * <p>
- * If <code>aUserIdentity</code> is not a renderable node, the argument will be considered as <code>null</code>, i.e.
- * the renderer will not have any renderable node in subsequent render execution.
- * </p>
- * @param aUserIdentity a user identity node, or a user that has an identity on current site
- */
-export function update(aUserIdentity: Node): void;
-
-/**
- * Whether or not this renderer contains a user identity.
- * @return <code>true</code> if a renderable node is loaded, <code>false</code> if not.
- */
-export function isLoaded(): boolean;
-
-/**
- * Helper method to check if a certain node can be rendered.
- *
- * <p>
- *    Nodes with the following primary node types are potentially renderable:
- * </p>
- * <ul>
- *    <li><code>sv:userIdentity</code></li>
- *    <li><code>sv:user</code> <em>(non-anonymous)</em> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
- *    <li><code>sv:simpleUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
- *    <li><code>sv:systemUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
- * </ul>
- * @param aNode the node to check
- * @return <code>true</code> if <code>aNode</code> is supported by this renderer, <code>false</code> if not
- */
-export function isRenderable(aNode: Node): boolean;
-
-/**
- * Helper method to check if a named user field is available.
- *
- * <p>
- *    <strong>An important note about field names and user field lookup!</strong> A specific user field can be found
- *    via <em>multiple</em> names:
- * </p>
- * <ol>
- *    <li>Primarily user fields are found via their <em>UI name</em>.</li>
- *    <li>Secondary user fields are found via their <em>Ldap name</em> (ldap-read fields only).</li>
- *    <li>As last resort user fields are found via their <em>Index name</em>.</li>
- * </ol>
- * <p>
- *    <em>First found match is used!</em>
- * </p>
- * <p>
- *    This is a convenience to make user fields easier to find, but <em>beware of colliding names</em>! For instance,
- *    if field A has Ldap name "X" and field B has UI name "X" - field B will be used.
- * </p>
- * @param aUserFieldName the name of the user field
- * @return <code>true</code> if current site has a user field that can be found via <code>aUserFieldName</code>, <code>false</code> if not
- */
-export function isValidFieldName(aUserFieldName: string): boolean;
-
-/**
- * Returns the value as html for a named user field for currently loaded user identity.
- *
- * <p>
- *    The rendered output of the user field value is handled as:
- * </p>
- * <ul>
- *    <li>The value is XML escaped (see: {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)})</li>
- *    <li>Line breaks are converted to &lt;br&gt; (see: {@link senselogic.sitevision.api.text.EndecUtil#br(String)})</li>
- *    <li>Potential links are converted to anchors (see: {@link senselogic.sitevision.api.render.OutputUtil#getHyperlinkedText(String)})</li>
- * </ul>
- *
- * <p>
- *    <em>Note! The result of this method is equivalent with calling {@link #getPlainUserFieldValueAsHtml(String)} with the
- *    result of the {@link #renderPlain(String)} method, but this method is more efficient and should always be preferred.</em>
- * </p>
- * @param aUserFieldName the name of the user field, see: {@link #isValidFieldName(String)}
- * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
- */
-export function render(aUserFieldName: string): string;
-
-/**
- * Returns the value as plain text for a named user field for currently loaded user identity.
- *
- * <p>
- *    <strong>Note!</strong> The rendered output is plain text and <em>must be escaped</em> if it should be part of the html output of a page!
- * </p>
- * @param aUserFieldName the name of the user field, see: {@link #isValidFieldName(String)}
- * @return a plain string. Might be empty but never <code>null</code>.
- * @since Sitevision 3.6
- * @see #render(String)
- */
-export function renderPlain(aUserFieldName: string): string;
-
-/**
- * Returns a plain text user field value as html.
- *
- * <p>
- *    <strong>Note!</strong> This method is <em>stateless</em>, i.e. you don't have to have a user identity loaded to call this method.
- *    Typically you would always use the {@link #render(String)} whenever possible. This method should only be used when you have a plain
- *    text user field value, but no user identity (e.g. in large search results where you want to avoid loading lots of user identity objects).
- * </p>
- * <p>
- *    The rendered output of the plain text user field value is handled as:
- * </p>
- * <ul>
- *    <li>The value is XML escaped (see: {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)})</li>
- *    <li>Line breaks are converted to &lt;br&gt; (see: {@link senselogic.sitevision.api.text.EndecUtil#br(String)})</li>
- *    <li>Potential links are converted to anchors (see: {@link senselogic.sitevision.api.render.OutputUtil#getHyperlinkedText(String)})</li>
- * </ul>
- * @param aPlainUserFieldValue the plain text user field value
- * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
- * @since Sitevision 3.6
- */
-export function getPlainUserFieldValueAsHtml(
-  aPlainUserFieldValue: string
-): string;
-
 /**
  * UserFieldRenderer is a stateful utility interface for rendering user field values for user identities.
  *
@@ -179,16 +63,124 @@ export function getPlainUserFieldValueAsHtml(
  * @author Magnus Lövgren
  * @since Sitevision 3.5.3
  */
-declare namespace userFieldRenderer {
-  export {
-    update,
-    isLoaded,
-    isRenderable,
-    isValidFieldName,
-    render,
-    renderPlain,
-    getPlainUserFieldValueAsHtml,
-  };
+export interface UserFieldRenderer {
+  /**
+   * Updates the renderer with a new user identity node.
+   *
+   * <p>
+   * If <code>aUserIdentity</code> is not a renderable node, the argument will be considered as <code>null</code>, i.e.
+   * the renderer will not have any renderable node in subsequent render execution.
+   * </p>
+   * @param aUserIdentity a user identity node, or a user that has an identity on current site
+   */
+  update(aUserIdentity: Node): void;
+
+  /**
+   * Whether or not this renderer contains a user identity.
+   * @return <code>true</code> if a renderable node is loaded, <code>false</code> if not.
+   */
+  isLoaded(): boolean;
+
+  /**
+   * Helper method to check if a certain node can be rendered.
+   *
+   * <p>
+   *    Nodes with the following primary node types are potentially renderable:
+   * </p>
+   * <ul>
+   *    <li><code>sv:userIdentity</code></li>
+   *    <li><code>sv:user</code> <em>(non-anonymous)</em> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+   *    <li><code>sv:simpleUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+   *    <li><code>sv:systemUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+   * </ul>
+   * @param aNode the node to check
+   * @return <code>true</code> if <code>aNode</code> is supported by this renderer, <code>false</code> if not
+   */
+  isRenderable(aNode: Node): boolean;
+
+  /**
+   * Helper method to check if a named user field is available.
+   *
+   * <p>
+   *    <strong>An important note about field names and user field lookup!</strong> A specific user field can be found
+   *    via <em>multiple</em> names:
+   * </p>
+   * <ol>
+   *    <li>Primarily user fields are found via their <em>UI name</em>.</li>
+   *    <li>Secondary user fields are found via their <em>Ldap name</em> (ldap-read fields only).</li>
+   *    <li>As last resort user fields are found via their <em>Index name</em>.</li>
+   * </ol>
+   * <p>
+   *    <em>First found match is used!</em>
+   * </p>
+   * <p>
+   *    This is a convenience to make user fields easier to find, but <em>beware of colliding names</em>! For instance,
+   *    if field A has Ldap name "X" and field B has UI name "X" - field B will be used.
+   * </p>
+   * @param aUserFieldName the name of the user field
+   * @return <code>true</code> if current site has a user field that can be found via <code>aUserFieldName</code>, <code>false</code> if not
+   */
+  isValidFieldName(aUserFieldName: string): boolean;
+
+  /**
+   * Returns the value as html for a named user field for currently loaded user identity.
+   *
+   * <p>
+   *    The rendered output of the user field value is handled as:
+   * </p>
+   * <ul>
+   *    <li>The value is XML escaped (see: {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)})</li>
+   *    <li>Line breaks are converted to &lt;br&gt; (see: {@link senselogic.sitevision.api.text.EndecUtil#br(String)})</li>
+   *    <li>Potential links are converted to anchors (see: {@link senselogic.sitevision.api.render.OutputUtil#getHyperlinkedText(String)})</li>
+   * </ul>
+   *
+   * <p>
+   *    <em>Note! The result of this method is equivalent with calling {@link #getPlainUserFieldValueAsHtml(String)} with the
+   *    result of the {@link #renderPlain(String)} method, but this method is more efficient and should always be preferred.</em>
+   * </p>
+   * @param aUserFieldName the name of the user field, see: {@link #isValidFieldName(String)}
+   * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
+   */
+  render(aUserFieldName: string): string;
+
+  /**
+   * Returns the value as plain text for a named user field for currently loaded user identity.
+   *
+   * <p>
+   *    <strong>Note!</strong> The rendered output is plain text and <em>must be escaped</em> if it should be part of the html output of a page!
+   * </p>
+   * @param aUserFieldName the name of the user field, see: {@link #isValidFieldName(String)}
+   * @return a plain string. Might be empty but never <code>null</code>.
+   * @since Sitevision 3.6
+   * @see #render(String)
+   */
+  renderPlain(aUserFieldName: string): string;
+
+  /**
+   * Returns a plain text user field value as html.
+   *
+   * <p>
+   *    <strong>Note!</strong> This method is <em>stateless</em>, i.e. you don't have to have a user identity loaded to call this method.
+   *    Typically you would always use the {@link #render(String)} whenever possible. This method should only be used when you have a plain
+   *    text user field value, but no user identity (e.g. in large search results where you want to avoid loading lots of user identity objects).
+   * </p>
+   * <p>
+   *    The rendered output of the plain text user field value is handled as:
+   * </p>
+   * <ul>
+   *    <li>The value is XML escaped (see: {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)})</li>
+   *    <li>Line breaks are converted to &lt;br&gt; (see: {@link senselogic.sitevision.api.text.EndecUtil#br(String)})</li>
+   *    <li>Potential links are converted to anchors (see: {@link senselogic.sitevision.api.render.OutputUtil#getHyperlinkedText(String)})</li>
+   * </ul>
+   * @param aPlainUserFieldValue the plain text user field value
+   * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
+   * @since Sitevision 3.6
+   */
+  getPlainUserFieldValueAsHtml(aPlainUserFieldValue: string): string;
 }
 
+declare namespace UserFieldRenderer {}
+
+declare var userFieldRenderer: UserFieldRenderer;
+
 export default userFieldRenderer;

package/server/UserIdentityUtil/index.d.ts

@@ -1,37 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * Creates the corresponding <code>sv:userIdentity</code> Node for a specified <code>sv:user</code> Node.
- *
- * <p>
- *    <strong>Note!</strong> When Collaboration is activated for a site, user identities are automatically created
- *    for each user when they authenticates themselves. This method is typically used for "infrequent" users during
- *    the startup phase of using Collaboration.
- * </p>
- * <p>
- *    <em>Note that neither anonymous users, the indexer or the extractor can have a user identity!</em>
- * </p>
- * @param aUserNode a user node that presumably do not have a corresponding user identity
- * @return the existing or created sv:userIdentity Node for <code>aUserNode</code>, or <code>null</code> if <code>aUserNode</code> is <code>null</code> or isn't allowed to have user identity for current site (e.g. user is anonymized).
- * @see #getUserIdentity(javax.jcr.Node)
- */
-export function getOrCreateUserIdentity(aUserNode: Node): Node;
-
-/**
- * Gets the corresponding <code>sv:userIdentity</code> Node for a specified <code>sv:user</code> Node.
- *
- * <p>
- *    <em>Note that neither anonymous users, the indexer or the extractor user has a user identity!</em>
- * </p>
- * <p>
- *    <em>Tip!</em> Use {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUserIdentity()} for getting
- *    the user identity of current user.
- * </p>
- * @param aUserNode a user node
- * @return the corresponding sv:userIdentity Node for <code>aUserNode</code>, or <code>null</code> if <code>aUserNode</code> is <code>null</code> or has no corresponding user identity for current site (e.g. user is anonymized).
- */
-export function getUserIdentity(aUserNode: Node): Node;
-
 /**
  * User identity utility interface.
  *
@@ -48,8 +16,42 @@ export function getUserIdentity(aUserNode: Node): Node;
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace userIdentityUtil {
-  export { getOrCreateUserIdentity, getUserIdentity };
+export interface UserIdentityUtil {
+  /**
+   * Creates the corresponding <code>sv:userIdentity</code> Node for a specified <code>sv:user</code> Node.
+   *
+   * <p>
+   *    <strong>Note!</strong> When Collaboration is activated for a site, user identities are automatically created
+   *    for each user when they authenticates themselves. This method is typically used for "infrequent" users during
+   *    the startup phase of using Collaboration.
+   * </p>
+   * <p>
+   *    <em>Note that neither anonymous users, the indexer or the extractor can have a user identity!</em>
+   * </p>
+   * @param aUserNode a user node that presumably do not have a corresponding user identity
+   * @return the existing or created sv:userIdentity Node for <code>aUserNode</code>, or <code>null</code> if <code>aUserNode</code> is <code>null</code> or isn't allowed to have user identity for current site (e.g. user is anonymized).
+   * @see #getUserIdentity(javax.jcr.Node)
+   */
+  getOrCreateUserIdentity(aUserNode: Node): Node;
+
+  /**
+   * Gets the corresponding <code>sv:userIdentity</code> Node for a specified <code>sv:user</code> Node.
+   *
+   * <p>
+   *    <em>Note that neither anonymous users, the indexer or the extractor user has a user identity!</em>
+   * </p>
+   * <p>
+   *    <em>Tip!</em> Use {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUserIdentity()} for getting
+   *    the user identity of current user.
+   * </p>
+   * @param aUserNode a user node
+   * @return the corresponding sv:userIdentity Node for <code>aUserNode</code>, or <code>null</code> if <code>aUserNode</code> is <code>null</code> or has no corresponding user identity for current site (e.g. user is anonymized).
+   */
+  getUserIdentity(aUserNode: Node): Node;
 }
 
+declare namespace UserIdentityUtil {}
+
+declare var userIdentityUtil: UserIdentityUtil;
+
 export default userIdentityUtil;

package/server/UserUtil/index.d.ts

@@ -1,31 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * Checks if current user is member of a group.
- *
- * <p>
- *    This is a convenience for {@link #isMemberOfGroup(javax.jcr.Node, javax.jcr.Node)} using current user
- *    (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).
- * </p>
- * @param aGroup a group node (sv:userGroup or sv:virtualGroup)
- * @return <code>true</code> if current user is member of <code>aGroup</code>, <code>false</code> otherwise
- */
-export function isMemberOfGroup(aGroup: Node): boolean;
-
-/**
- * Checks if a specific user is member of a group.
- *
- * <p>
- *    <em>Tip!</em> To check if a <code>sv:userIdentity</code> is member of a <code>sv:collaborationGroup</code>,
- *    you would typically use {@link senselogic.sitevision.api.user.UserIdentityWrapper#isMemberOf(javax.jcr.Node)} or
- *    {@link senselogic.sitevision.api.collaboration.CollaborationGroupWrapper#isMember(javax.jcr.Node)}.
- * </p>
- * @param aUser a user node (sv:user, sv:simpleUser or sv:systemUser)
- * @param aGroup a group node (sv:userGroup or sv:virtualGroup)
- * @return <code>true</code> if <code>aUser</code> is member of <code>aGroup</code>, <code>false</code> otherwise
- */
-export function isMemberOfGroup(aUser: Node, aGroup: Node): boolean;
-
 /**
  * User utility interface.
  *
@@ -63,8 +37,36 @@ export function isMemberOfGroup(aUser: Node, aGroup: Node): boolean;
  * @see senselogic.sitevision.api.user.SystemUserUtil
  * @see senselogic.sitevision.api.user.SimpleUserUtil
  */
-declare namespace userUtil {
-  export { isMemberOfGroup };
+export interface UserUtil {
+  /**
+   * Checks if current user is member of a group.
+   *
+   * <p>
+   *    This is a convenience for {@link #isMemberOfGroup(javax.jcr.Node, javax.jcr.Node)} using current user
+   *    (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).
+   * </p>
+   * @param aGroup a group node (sv:userGroup or sv:virtualGroup)
+   * @return <code>true</code> if current user is member of <code>aGroup</code>, <code>false</code> otherwise
+   */
+  isMemberOfGroup(aGroup: Node): boolean;
+
+  /**
+   * Checks if a specific user is member of a group.
+   *
+   * <p>
+   *    <em>Tip!</em> To check if a <code>sv:userIdentity</code> is member of a <code>sv:collaborationGroup</code>,
+   *    you would typically use {@link senselogic.sitevision.api.user.UserIdentityWrapper#isMemberOf(javax.jcr.Node)} or
+   *    {@link senselogic.sitevision.api.collaboration.CollaborationGroupWrapper#isMember(javax.jcr.Node)}.
+   * </p>
+   * @param aUser a user node (sv:user, sv:simpleUser or sv:systemUser)
+   * @param aGroup a group node (sv:userGroup or sv:virtualGroup)
+   * @return <code>true</code> if <code>aUser</code> is member of <code>aGroup</code>, <code>false</code> otherwise
+   */
+  isMemberOfGroup(aUser: Node, aGroup: Node): boolean;
 }
 
+declare namespace UserUtil {}
+
+declare var userUtil: UserUtil;
+
 export default userUtil;