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

package/server/LinkTargetBuilder/index.d.ts

@@ -3,69 +3,6 @@ import type { Node } from "../../types/javax/jcr/Node";
 import type { LinkTarget } from "../../types/senselogic/sitevision/api/webresource/LinkTarget";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
-/**
- * Sets the target.
- * @param aNode the target, must be a linkable resource (i.e. a page/article/image/file or such) that isn't trashed.
- * @return this builder
- * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or not a linkable resource.
- */
-export function setInternalTarget(aNode: Node): LinkTargetBuilder;
-
-/**
- * Sets the target.
- * @param aURL the link target URL
- * @return this builder
- * @throws IllegalArgumentException if <code>aURL</code> is <code>null</code> or whitespace only
- */
-export function setExternalTarget(aURL: string): LinkTargetBuilder;
-
-/**
- * Sets the target.
- * @param aMailAddress a mail address
- * @return this builder
- * @throws IllegalArgumentException if <code>aMailAddress</code> is <code>null</code>, whitespace only or an invalid mail address.
- * @see senselogic.sitevision.api.mail.MailUtil#isValidAddress(String)
- */
-export function setMailTarget(aMailAddress: string): LinkTargetBuilder;
-
-/**
- * Sets the target.
- * @param aPhoneNumber a phone number
- * @return this builder
- * @throws IllegalArgumentException if <code>aPhoneNumber</code> is <code>null</code>, whitespace only or an invalid phone number.
- */
-export function setPhoneTarget(aPhoneNumber: string): LinkTargetBuilder;
-
-/**
- * Sets the description.
- * @param aDescription the description
- * @return this builder
- */
-export function setDescription(aDescription: string): LinkTargetBuilder;
-
-/**
- * Sets open in new window.
- * @param aOpenInNewWindow whether or not the target should be opened in new window
- * @return this builder
- */
-export function setOpenInNewWindow(
-  aOpenInNewWindow: boolean
-): LinkTargetBuilder;
-
-/**
- * Creates a LinkTarget instance using current state of this builder.
- *
- * <p>
- *    <em>
- *       Note! The 'open in new window' state is ignored when creating a LinkTarget with
- *       a mail or telephone target (these target types can never be opened in a new window).
- *    </em>
- * </p>
- * @return a link target
- * @throws IllegalStateException if there are no link target.
- */
-export function build(): LinkTarget;
-
 /**
  * Builder to create link target instances that can be used to create and update a Link page
  * via {@link senselogic.sitevision.api.webresource.LinkPageUtil}.
@@ -126,16 +63,71 @@ export function build(): LinkTarget;
  * @since Sitevision 4.2
  * @see senselogic.sitevision.api.webresource.LinkPageUtil
  */
-declare namespace linkTargetBuilder {
-  export {
-    setInternalTarget,
-    setExternalTarget,
-    setMailTarget,
-    setPhoneTarget,
-    setDescription,
-    setOpenInNewWindow,
-    build,
-  };
+export interface LinkTargetBuilder extends Builder {
+  /**
+   * Sets the target.
+   * @param aNode the target, must be a linkable resource (i.e. a page/article/image/file or such) that isn't trashed.
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or not a linkable resource.
+   */
+  setInternalTarget(aNode: Node): LinkTargetBuilder;
+
+  /**
+   * Sets the target.
+   * @param aURL the link target URL
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aURL</code> is <code>null</code> or whitespace only
+   */
+  setExternalTarget(aURL: string): LinkTargetBuilder;
+
+  /**
+   * Sets the target.
+   * @param aMailAddress a mail address
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aMailAddress</code> is <code>null</code>, whitespace only or an invalid mail address.
+   * @see senselogic.sitevision.api.mail.MailUtil#isValidAddress(String)
+   */
+  setMailTarget(aMailAddress: string): LinkTargetBuilder;
+
+  /**
+   * Sets the target.
+   * @param aPhoneNumber a phone number
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aPhoneNumber</code> is <code>null</code>, whitespace only or an invalid phone number.
+   */
+  setPhoneTarget(aPhoneNumber: string): LinkTargetBuilder;
+
+  /**
+   * Sets the description.
+   * @param aDescription the description
+   * @return this builder
+   */
+  setDescription(aDescription: string): LinkTargetBuilder;
+
+  /**
+   * Sets open in new window.
+   * @param aOpenInNewWindow whether or not the target should be opened in new window
+   * @return this builder
+   */
+  setOpenInNewWindow(aOpenInNewWindow: boolean): LinkTargetBuilder;
+
+  /**
+   * Creates a LinkTarget instance using current state of this builder.
+   *
+   * <p>
+   *    <em>
+   *       Note! The 'open in new window' state is ignored when creating a LinkTarget with
+   *       a mail or telephone target (these target types can never be opened in a new window).
+   *    </em>
+   * </p>
+   * @return a link target
+   * @throws IllegalStateException if there are no link target.
+   */
+  build(): LinkTarget;
 }
 
+declare namespace LinkTargetBuilder {}
+
+declare var linkTargetBuilder: LinkTargetBuilder;
+
 export default linkTargetBuilder;

package/server/LinkValueBuilder/index.d.ts

@@ -3,68 +3,6 @@ import type { Node } from "../../types/javax/jcr/Node";
 import type { LinkValue } from "../../types/senselogic/sitevision/api/metadata/value/LinkValue";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
-/**
- * Sets the target.
- * @param anURL the link target URL
- * @return this builder
- * @throws IllegalArgumentException if <code>anURL</code> is <code>null</code> or whitespace only
- */
-export function setExternalTarget(anURL: string): LinkValueBuilder;
-
-/**
- * Sets the target.
- * @param aMailAddress a mail address
- * @return this builder
- * @throws IllegalArgumentException if <code>aMailAddress</code> is <code>null</code>, whitespace only or an invalid mail address.
- * @see senselogic.sitevision.api.mail.MailUtil#isValidAddress(String)
- */
-export function setMailTarget(aMailAddress: string): LinkValueBuilder;
-
-/**
- * Sets the target.
- * @param aPhoneNumber a phone number
- * @return this builder
- * @throws IllegalArgumentException if <code>aPhoneNumber</code> is <code>null</code>, whitespace only or an invalid phone number.
- * @since Sitevision 4.2.1
- */
-export function setPhoneTarget(aPhoneNumber: string): LinkValueBuilder;
-
-/**
- * Sets the target.
- * @param aNode the target, must be a linkable resource (i.e. a page/article/image/file or such) that isn't trashed.
- * @return this builder
- * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or not a linkable resource.
- */
-export function setInternalTarget(aNode: Node): LinkValueBuilder;
-
-/**
- * Sets the link name.
- * @param aName the link name
- * @return this builder
- */
-export function setName(aName: string): LinkValueBuilder;
-
-/**
- * Sets the link description.
- * @param aDescription the link description
- * @return this builder
- */
-export function setDescription(aDescription: string): LinkValueBuilder;
-
-/**
- * Sets open in new window.
- * @param aOpenInNewWindow whether or not the link should be opened in new window
- * @return this builder
- */
-export function setOpenInNewWindow(aOpenInNewWindow: boolean): LinkValueBuilder;
-
-/**
- * Creates a LinkValue instance using current state of this builder.
- * @return a link value
- * @throws IllegalStateException if there are no link target.
- */
-export function build(): LinkValue;
-
 /**
  * Builder to create LinkValue instances that can be used to set link metadata.
  *
@@ -127,17 +65,72 @@ export function build(): LinkValue;
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace linkValueBuilder {
-  export {
-    setExternalTarget,
-    setMailTarget,
-    setPhoneTarget,
-    setInternalTarget,
-    setName,
-    setDescription,
-    setOpenInNewWindow,
-    build,
-  };
+export interface LinkValueBuilder extends Builder {
+  /**
+   * Sets the target.
+   * @param anURL the link target URL
+   * @return this builder
+   * @throws IllegalArgumentException if <code>anURL</code> is <code>null</code> or whitespace only
+   */
+  setExternalTarget(anURL: string): LinkValueBuilder;
+
+  /**
+   * Sets the target.
+   * @param aMailAddress a mail address
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aMailAddress</code> is <code>null</code>, whitespace only or an invalid mail address.
+   * @see senselogic.sitevision.api.mail.MailUtil#isValidAddress(String)
+   */
+  setMailTarget(aMailAddress: string): LinkValueBuilder;
+
+  /**
+   * Sets the target.
+   * @param aPhoneNumber a phone number
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aPhoneNumber</code> is <code>null</code>, whitespace only or an invalid phone number.
+   * @since Sitevision 4.2.1
+   */
+  setPhoneTarget(aPhoneNumber: string): LinkValueBuilder;
+
+  /**
+   * Sets the target.
+   * @param aNode the target, must be a linkable resource (i.e. a page/article/image/file or such) that isn't trashed.
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or not a linkable resource.
+   */
+  setInternalTarget(aNode: Node): LinkValueBuilder;
+
+  /**
+   * Sets the link name.
+   * @param aName the link name
+   * @return this builder
+   */
+  setName(aName: string): LinkValueBuilder;
+
+  /**
+   * Sets the link description.
+   * @param aDescription the link description
+   * @return this builder
+   */
+  setDescription(aDescription: string): LinkValueBuilder;
+
+  /**
+   * Sets open in new window.
+   * @param aOpenInNewWindow whether or not the link should be opened in new window
+   * @return this builder
+   */
+  setOpenInNewWindow(aOpenInNewWindow: boolean): LinkValueBuilder;
+
+  /**
+   * Creates a LinkValue instance using current state of this builder.
+   * @return a link value
+   * @throws IllegalStateException if there are no link target.
+   */
+  build(): LinkValue;
 }
 
+declare namespace LinkValueBuilder {}
+
+declare var linkValueBuilder: LinkValueBuilder;
+
 export default linkValueBuilder;

package/server/ListWrapper/index.d.ts

@@ -1,81 +1,5 @@
 import type { Wrapper } from "../../types/senselogic/sitevision/api/base/Wrapper";
 
-/**
- * Appends the specified element (if non-null) to the end of the wrapped list.
- *
- * <p>
- *    <strong>Important!</strong> Null values in lists are inherently bad. This method will <strong>not</strong>
- *    delegate any <code>null</code> to the wrapped list.
- *    If you <em>must</em> add a <code>null</code> value, you can explicitly do it to the wrapped list, i.e:
- * </p>
- * <pre><code>
- *    #set ($myList = $instanceCreatorUtil.listWrapper)
- *    ...
- *    $myList.add($anObject.aMethod())          <em>## Will only delegate non-nulls to the wrapped list</em>
- *    $myList.unwrap().add($anObject.aMethod()) <em>## Will add any value directly to the wrapped list</em>
- * </code></pre>
- * @param anObject the element to be appended to the wrapped list, <code>null</code> will be ignored.
- */
-export function add(anObject: unknown): void;
-
-/**
- * Removes all of the elements from the wrapped list.
-  
-    */
-export function clear(): void;
-
-/**
- * Checks if the wrapped list contains a specified object.
- * @param anObject an element to check for in the wrapped list.
- * @return <code>true</code> if the wrapped list contains the specified element
- */
-export function contains(anObject: unknown): boolean;
-
-/**
- * Returns the element at the specified position in the wrapped list.
- * @param anIndex index of the element in the wrapped list to return
- * @return the element at the specified position in the wrapped list
- * @throws IndexOutOfBoundsException if the index is out of range (<code>index &lt; 0 || index &gt;= size()</code>)
- */
-export function get(anIndex: number): unknown;
-
-/**
- * Whether or not the wrapped list is empty (contains no elements).
- * @return <code>true</code> if the wrapped list contains no elements
- */
-export function isEmpty(): boolean;
-
-/**
- * Returns an iterator for the wrapped list.
- * @return an Iterator.
- */
-export function iterator(): unknown;
-
-/**
- * The size (number of elements) of the wrapped list.
- * @return the number of elements in the wrapped list
- */
-export function size(): number;
-
-/**
- * Returns an array containing all of the elements in the wrapped list.
- * @return an array containing the elements of the wrapped list
- */
-export function toArray(): unknown;
-
-/**
- * Sorts the wrapped list.
- * @param aComparator the comparator to use when sorting
- * @since Sitevision 4.0
- */
-export function sort(aComparator: unknown): void;
-
-/**
- * Returns the wrapped List.
- * @return the List wrapped by this ListWrapper
- */
-export function unwrap(): unknown;
-
 /**
  * An convenience <code>java.util.List</code> wrapper that delegates method calls to the wrapped list.
  *
@@ -144,19 +68,86 @@ export function unwrap(): unknown;
  * @author Magnus Lövgren
  * @since Sitevision 3.5
  */
-declare namespace listWrapper {
-  export {
-    add,
-    clear,
-    contains,
-    get,
-    isEmpty,
-    iterator,
-    size,
-    toArray,
-    sort,
-    unwrap,
-  };
+export interface ListWrapper extends Wrapper {
+  /**
+   * Appends the specified element (if non-null) to the end of the wrapped list.
+   *
+   * <p>
+   *    <strong>Important!</strong> Null values in lists are inherently bad. This method will <strong>not</strong>
+   *    delegate any <code>null</code> to the wrapped list.
+   *    If you <em>must</em> add a <code>null</code> value, you can explicitly do it to the wrapped list, i.e:
+   * </p>
+   * <pre><code>
+   *    #set ($myList = $instanceCreatorUtil.listWrapper)
+   *    ...
+   *    $myList.add($anObject.aMethod())          <em>## Will only delegate non-nulls to the wrapped list</em>
+   *    $myList.unwrap().add($anObject.aMethod()) <em>## Will add any value directly to the wrapped list</em>
+   * </code></pre>
+   * @param anObject the element to be appended to the wrapped list, <code>null</code> will be ignored.
+   */
+  add(anObject: unknown): void;
+
+  /**
+ * Removes all of the elements from the wrapped list.
+  
+    */
+  clear(): void;
+
+  /**
+   * Checks if the wrapped list contains a specified object.
+   * @param anObject an element to check for in the wrapped list.
+   * @return <code>true</code> if the wrapped list contains the specified element
+   */
+  contains(anObject: unknown): boolean;
+
+  /**
+   * Returns the element at the specified position in the wrapped list.
+   * @param anIndex index of the element in the wrapped list to return
+   * @return the element at the specified position in the wrapped list
+   * @throws IndexOutOfBoundsException if the index is out of range (<code>index &lt; 0 || index &gt;= size()</code>)
+   */
+  get(anIndex: number): unknown;
+
+  /**
+   * Whether or not the wrapped list is empty (contains no elements).
+   * @return <code>true</code> if the wrapped list contains no elements
+   */
+  isEmpty(): boolean;
+
+  /**
+   * Returns an iterator for the wrapped list.
+   * @return an Iterator.
+   */
+  iterator(): unknown;
+
+  /**
+   * The size (number of elements) of the wrapped list.
+   * @return the number of elements in the wrapped list
+   */
+  size(): number;
+
+  /**
+   * Returns an array containing all of the elements in the wrapped list.
+   * @return an array containing the elements of the wrapped list
+   */
+  toArray(): unknown;
+
+  /**
+   * Sorts the wrapped list.
+   * @param aComparator the comparator to use when sorting
+   * @since Sitevision 4.0
+   */
+  sort(aComparator: unknown): void;
+
+  /**
+   * Returns the wrapped List.
+   * @return the List wrapped by this ListWrapper
+   */
+  unwrap(): unknown;
 }
 
+declare namespace ListWrapper {}
+
+declare var listWrapper: ListWrapper;
+
 export default listWrapper;