@sitevision/api 2023.2.1 → 2023.2.2-beta.1

package/server/ColorUtil/index.d.ts

@@ -1,12 +1,13 @@
+import type { String } from "../../types/java/lang/String";
 import type { Node } from "../../types/javax/jcr/Node";
 
 /**
  * Utility interface for Colors.
  *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getColorUtil()}.
- * 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#getColorUtil()}.
+ *  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 ColorUtil {
@@ -15,7 +16,7 @@ export interface ColorUtil {
    * @param aColorName the name of the font
    * @return the first color with name aColorName, or <code>null</code> if no color matches
    */
-  getColorByName(aColorName: string): Node;
+  getColorByName(aColorName: String | string): Node;
 
   /**
    * Gets the color with a given name with a fallback value if no color matches
@@ -23,14 +24,14 @@ export interface ColorUtil {
    * @param aDefaultValue fallback value
    * @return the first color with name aColorName, or aDefaultValue if no color matches
    */
-  getColorByName(aColorName: string, aDefaultValue: Node): Node;
+  getColorByName(aColorName: String | string, aDefaultValue: Node): Node;
 
   /**
    * Gets the color with a given html hex value (i.e. a '#' followed by 6 characters [0-9,a-f,A-F]).
    * @param aHexString the hex string value of the font (starts with a '#' and ends with 6 characters [0-9,a-f,A-F])
    * @return the first color with the corresponding hex string, or <code>null</code> if no color matches
    */
-  getColorByHtmlHexValue(aHexString: string): Node;
+  getColorByHtmlHexValue(aHexString: String | string): Node;
 
   /**
    * Gets the color with a given html hex value (i.e. a '#' followed by 6 characters [0-9,a-f,A-F]) with a fallback value if no color matches.
@@ -38,7 +39,10 @@ export interface ColorUtil {
    * @param aDefaultValue fallback value
    * @return the first color with the corresponding hex string, or aDefaultValue if no color matches
    */
-  getColorByHtmlHexValue(aHexString: string, aDefaultValue: Node): Node;
+  getColorByHtmlHexValue(
+    aHexString: String | string,
+    aDefaultValue: Node
+  ): Node;
 }
 
 declare namespace ColorUtil {}

package/server/CompoundAndFilterBuilder/index.d.ts

@@ -4,25 +4,25 @@ import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder
 /**
  * Builds a compound filter that requires that <em>all</em> added filters matches.
  *
- * <p>
- *    <em>How a compound AND filter works:</em> If filter <em>A</em> and filter <em>B</em> is added to this builder,
- *    then the accept method of the built filter will return the boolean result of the logical boolean evaluation of:
- *    <em>A.accept AND B.accept</em>.
- * </p>
- * <ul>
- *    <li>
- *       See {@link senselogic.sitevision.api.node.NodeFilterUtil} for an example of how to use a <code>CompoundAndFilterBuilder</code> in Velocity.
- *    </li>
- *    <li>
- *       See {@link senselogic.sitevision.api.base.Builder} for a comprehensive example of how to work with builders.
- *    </li>
- * </ul>
+ *  <p>
+ *     <em>How a compound AND filter works:</em> If filter <em>A</em> and filter <em>B</em> is added to this builder,
+ *     then the accept method of the built filter will return the boolean result of the logical boolean evaluation of:
+ *     <em>A.accept AND B.accept</em>.
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        See {@link senselogic.sitevision.api.node.NodeFilterUtil} for an example of how to use a <code>CompoundAndFilterBuilder</code> in Velocity.
+ *     </li>
+ *     <li>
+ *        See {@link senselogic.sitevision.api.base.Builder} for a comprehensive example of how to work with builders.
+ *     </li>
+ *  </ul>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.node.NodeFilterUtil#getCompoundAndFilterBuilder()}.
- *    See {@link senselogic.sitevision.api.node.NodeFilterUtil} for how to obtain an instance of the <code>NodeFilterUtil</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.node.NodeFilterUtil#getCompoundAndFilterBuilder()}.
+ *     See {@link senselogic.sitevision.api.node.NodeFilterUtil} for how to obtain an instance of the <code>NodeFilterUtil</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */
@@ -30,9 +30,9 @@ export interface CompoundAndFilterBuilder extends Builder {
   /**
    * Adds a node filter to this builder.
    *
-   * <p>
-   *    <em>Tip!</em> For best performance, it's likely a good idea to add the "cheapest" filter first!
-   * </p>
+   *  <p>
+   *     <em>Tip!</em> For best performance, it's likely a good idea to add the "cheapest" filter first!
+   *  </p>
    * @param aFilter the node filter to add, <code>null</code> will be ignored
    * @return this builder
    */

package/server/CompoundComparatorBuilder/index.d.ts

@@ -1,22 +1,23 @@
+import type { Comparator } from "../../types/java/util/Comparator";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
 /**
  * Builds a compound comparator that allows comparison based on multiple comparators.
  *
- * <p>
- *    <em>How the compareTo method of a compound comparator works:</em> If comparator <em>A</em> and comparator <em>B</em> is added to this builder,
- *    then the compareTo method of <em>A</em> will be invoked first, and if equal (i.e. zero), the compareTo of <em>B</em> will be invoked.
- * </p>
+ *  <p>
+ *     <em>How the compareTo method of a compound comparator works:</em> If comparator <em>A</em> and comparator <em>B</em> is added to this builder,
+ *     then the compareTo method of <em>A</em> will be invoked first, and if equal (i.e. zero), the compareTo of <em>B</em> will be invoked.
+ *  </p>
  *
- * <p>
- *    See {@link senselogic.sitevision.api.base.Builder} for a comprehensive example of how to work with builders.
- * </p>
+ *  <p>
+ *     See {@link senselogic.sitevision.api.base.Builder} for a comprehensive example of how to work with builders.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.node.NodeComparatorUtil#getCompoundComparatorBuilder()}.
- *    See {@link senselogic.sitevision.api.node.NodeComparatorUtil} for how to obtain an instance of the <code>NodeComparatorUtil</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.node.NodeComparatorUtil#getCompoundComparatorBuilder()}.
+ *     See {@link senselogic.sitevision.api.node.NodeComparatorUtil} for how to obtain an instance of the <code>NodeComparatorUtil</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.3
  */
@@ -24,14 +25,14 @@ export interface CompoundComparatorBuilder extends Builder {
   /**
    * Adds a node comparator to this builder.
    *
-   * <p>
-   *    <em>Note!</em> Order is important. The compareTo method of a node comparator constructed from this builder will invoke the
-   *    comparators in the order they were added.
-   * </p>
+   *  <p>
+   *     <em>Note!</em> Order is important. The compareTo method of a node comparator constructed from this builder will invoke the
+   *     comparators in the order they were added.
+   *  </p>
    * @param aComparator the node comparator to add, <code>null</code> will be ignored
    * @return this builder
    */
-  addComparator(aComparator: unknown): CompoundComparatorBuilder;
+  addComparator(aComparator: Comparator): CompoundComparatorBuilder;
 
   /**
    * Removes all previously added comparators.
@@ -42,13 +43,13 @@ export interface CompoundComparatorBuilder extends Builder {
   /**
    * Creates a node comparator instance that will calculate its compareTo return value based on currently specified comparators.
    *
-   * <p>
-   *    <em>Note! The returned Comparator imposes orderings that are inconsistent with equals.</em>
-   * </p>
+   *  <p>
+   *     <em>Note! The returned Comparator imposes orderings that are inconsistent with equals.</em>
+   *  </p>
    * @return a node comparator
    * @throws IllegalStateException if this builder contains no comparators.
    */
-  build(): unknown;
+  build(): Comparator;
 }
 
 declare namespace CompoundComparatorBuilder {}

package/server/CompoundOrFilterBuilder/index.d.ts

@@ -4,24 +4,24 @@ import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder
 /**
  * Builds a compound filter that requires that <em>any</em> of the added filters matches.
  *
- * <p>
- *    <em>How a compound OR filter works:</em> If filter <em>A</em> and filter <em>B</em> is added to this builder,
- *    then the accept method of the built filter will return the result of the logical boolean evaluation of: <em>A.accept OR B.accept</em>.
- * </p>
- * <ul>
- *    <li>
- *       See {@link senselogic.sitevision.api.node.NodeFilterUtil} for an example of how to use a <code>CompoundOrFilterBuilder</code> in Velocity.
- *    </li>
- *    <li>
- *       See {@link senselogic.sitevision.api.base.Builder} for a comprehensive example of how to work with builders.
- *    </li>
- * </ul>
+ *  <p>
+ *     <em>How a compound OR filter works:</em> If filter <em>A</em> and filter <em>B</em> is added to this builder,
+ *     then the accept method of the built filter will return the result of the logical boolean evaluation of: <em>A.accept OR B.accept</em>.
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        See {@link senselogic.sitevision.api.node.NodeFilterUtil} for an example of how to use a <code>CompoundOrFilterBuilder</code> in Velocity.
+ *     </li>
+ *     <li>
+ *        See {@link senselogic.sitevision.api.base.Builder} for a comprehensive example of how to work with builders.
+ *     </li>
+ *  </ul>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.node.NodeFilterUtil#getCompoundOrFilterBuilder()}.
- *    See {@link senselogic.sitevision.api.node.NodeFilterUtil} for how to obtain an instance of the <code>NodeFilterUtil</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.node.NodeFilterUtil#getCompoundOrFilterBuilder()}.
+ *     See {@link senselogic.sitevision.api.node.NodeFilterUtil} for how to obtain an instance of the <code>NodeFilterUtil</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */
@@ -29,9 +29,9 @@ export interface CompoundOrFilterBuilder extends Builder {
   /**
    * Adds a node filter to this builder.
    *
-   * <p>
-   *    <em>Tip!</em> For best performance, it's likely a good idea to add the "cheapest" filter first!
-   * </p>
+   *  <p>
+   *     <em>Tip!</em> For best performance, it's likely a good idea to add the "cheapest" filter first!
+   *  </p>
    * @param aFilter the node filter to add, <code>null</code> will be ignored
    * @return this builder
    */

package/server/ContentNodeUtil/index.d.ts

@@ -3,23 +3,23 @@ import type { Node } from "../../types/javax/jcr/Node";
 /**
  * Content Node utility interface.
  *
- * <p>
- *    A <em>"Content node" (e.g sv:portlet)</em> is a Node that is located in the "content section" of a <em>"Renderable node" (e.g. sv:page)</em>.
- * </p>
- * <p>
- *    This utility is typically used to get the parent of a Content node, either the <em>content</em> parent (typically a sv:layout)
- *    or the <em>renderable</em> parent (typically a sv:page).
- * </p>
- * <p>
- *    The types of a "Content node" is defined in {@link senselogic.sitevision.api.node.NodeTypeUtil#isAnyContentType(Node)}.
- *    The types of a "Renderable node" is defined in {@link senselogic.sitevision.api.node.NodeTypeUtil#isAnyRenderableType(Node)}.
- * </p>
+ *  <p>
+ *     A <em>"Content node" (e.g sv:portlet)</em> is a Node that is located in the "content section" of a <em>"Renderable node" (e.g. sv:page)</em>.
+ *  </p>
+ *  <p>
+ *     This utility is typically used to get the parent of a Content node, either the <em>content</em> parent (typically a sv:layout)
+ *     or the <em>renderable</em> parent (typically a sv:page).
+ *  </p>
+ *  <p>
+ *     The types of a "Content node" is defined in {@link senselogic.sitevision.api.node.NodeTypeUtil#isAnyContentType(Node)}.
+ *     The types of a "Renderable node" is defined in {@link senselogic.sitevision.api.node.NodeTypeUtil#isAnyRenderableType(Node)}.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getContentNodeUtil()}.
- *    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#getContentNodeUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 10.2
  */
@@ -27,28 +27,28 @@ export interface ContentNodeUtil {
   /**
    * Gets the renderable parent of a given content node.
    *
-   * <p>
-   *    See {@link senselogic.sitevision.api.node.NodeTypeUtil#isAnyRenderableType(Node)} for what type a "Renderable node" can have.
-   * </p>
+   *  <p>
+   *     See {@link senselogic.sitevision.api.node.NodeTypeUtil#isAnyRenderableType(Node)} for what type a "Renderable node" can have.
+   *  </p>
    * @param aContentNode a content node, typically a sv:portlet or sv:layout
-   * @return the renderable parent of aContentNode (typically a sv:page), or null if aContentNode has no renderable parent or if current user doesn't have READ permission on the renderable parent
+   * @return the renderable parent of aContentNode (typically a sv:page), or null if aContentNode has no renderable parent or if current user&#xA; doesn't have READ permission on the renderable parent
    */
   getRenderableParent(aContentNode: Node): Node;
 
   /**
    * Gets the content parent of a given content node.
    *
-   * <p>
-   *    See {@link senselogic.sitevision.api.node.NodeTypeUtil#isAnyContentType(Node)} for what type a "Content node" can have.
-   * </p>
+   *  <p>
+   *     See {@link senselogic.sitevision.api.node.NodeTypeUtil#isAnyContentType(Node)} for what type a "Content node" can have.
+   *  </p>
    *
-   * <p>
-   *    <em>
-   *       <strong>Element disclaimer!</strong> The content structure of an Element (sv:moduleElement/sv:moduleElementDraft) potentially differs
-   *       in the OFFLINE and ONLINE versions.
-   *       Typically you should not use this method with <code>aContentNode</code> located within an Element.
-   *    </em>
-   * </p>
+   *  <p>
+   *     <em>
+   *        <strong>Element disclaimer!</strong> The content structure of an Element (sv:moduleElement/sv:moduleElementDraft) potentially differs
+   *        in the OFFLINE and ONLINE versions.
+   *        Typically you should not use this method with <code>aContentNode</code> located within an Element.
+   *     </em>
+   *  </p>
    * @param aContentNode a content node, typically a sv:portlet or sv:layout
    * @return the content parent of aContentNode (typically a sv:layout), or null if aContentNode has no content parent
    */

package/server/CurrencyFactory/index.d.ts

@@ -1,13 +1,15 @@
+import type { Locale } from "../../types/java/util/Locale";
 import type { Currency } from "../../types/senselogic/sitevision/api/i18n/Currency";
+import type { String } from "../../types/java/lang/String";
 
 /**
  * Factory for creating Currency instances.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getCurrencyFactory()}.
- *    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#getCurrencyFactory()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 6.1
  */
@@ -15,68 +17,68 @@ export interface CurrencyFactory {
   /**
    * Gets the Currency instance for a given locale.
    *
-   * <p>
-   *    <strong>Important Country Note!</strong> A Locale without a <em>country</em> can never have a Currency!
-   *    This method will always return <code>null</code> for such Locale.
-   * </p>
-   * <p>
-   *    <em>Tip!</em> {@link senselogic.sitevision.api.i18n.LocaleUtil#resolveCountryLocale(Locale)} might be helpful in order to
-   *    compensate for language-only locales.
-   * </p>
+   *  <p>
+   *     <strong>Important Country Note!</strong> A Locale without a <em>country</em> can never have a Currency!
+   *     This method will always return <code>null</code> for such Locale.
+   *  </p>
+   *  <p>
+   *     <em>Tip!</em> {@link senselogic.sitevision.api.i18n.LocaleUtil#resolveCountryLocale(Locale)} might be helpful in order to
+   *     compensate for language-only locales.
+   *  </p>
    *
-   * <p>
-   *    <em>This method is conceptually equivalent with the <code>java.util.Currency.getInstance(Locale)</code> method.</em>
-   * </p>
+   *  <p>
+   *     <em>This method is conceptually equivalent with the <code>java.util.Currency.getInstance(Locale)</code> method.</em>
+   *  </p>
    * @param aLocale the Locale
    * @return the Currency for aLocale, or null if aLocale is null or no Currency can be determined for aLocale
    * @see senselogic.sitevision.api.i18n.LocaleUtil#resolveCountryLocale(Locale)
    */
-  fromLocale(aLocale: unknown): Currency;
+  fromLocale(aLocale: Locale): Currency;
 
   /**
    * Gets the Currency instance for a given ISO 4217 Currency Code.
    *
-   * <p>
-   *    <a href="https://www.iso.org/iso-4217-currency-codes.html">
-   *       Currency codes are specified with a three-letter alphabetic code specified by ISO 4217
-   *    </a>
-   * </p>
+   *  <p>
+   *     <a href="https://www.iso.org/iso-4217-currency-codes.html">
+   *        Currency codes are specified with a three-letter alphabetic code specified by ISO 4217
+   *     </a>
+   *  </p>
    *
-   * <table>
-   *    <caption>Common currencies</caption>
-   *    <tr>
-   *       <th scope="col">Currency name</th>
-   *       <th scope="col">Currency code</th>
-   *    </tr>
-   *    <tr>
-   *       <td>US Dollar</td>
-   *       <td>USD</td>
-   *    </tr>
-   *    <tr>
-   *       <td>Euro</td>
-   *       <td>EUR</td>
-   *    </tr>
-   *    <tr>
-   *       <td>Brittish Pound</td>
-   *       <td>GBP</td>
-   *    </tr>
-   *    <tr>
-   *       <td>Swedish Krona</td>
-   *       <td>SEK</td>
-   *    </tr>
-   *    <tr>
-   *       <td>Norwegian Krone</td>
-   *       <td>NOK</td>
-   *    </tr>
-   * </table>
+   *  <table>
+   *     <caption>Common currencies</caption>
+   *     <tr>
+   *        <th scope="col">Currency name</th>
+   *        <th scope="col">Currency code</th>
+   *     </tr>
+   *     <tr>
+   *        <td>US Dollar</td>
+   *        <td>USD</td>
+   *     </tr>
+   *     <tr>
+   *        <td>Euro</td>
+   *        <td>EUR</td>
+   *     </tr>
+   *     <tr>
+   *        <td>Brittish Pound</td>
+   *        <td>GBP</td>
+   *     </tr>
+   *     <tr>
+   *        <td>Swedish Krona</td>
+   *        <td>SEK</td>
+   *     </tr>
+   *     <tr>
+   *        <td>Norwegian Krone</td>
+   *        <td>NOK</td>
+   *     </tr>
+   *  </table>
    *
-   * <p>
-   *    <em>This method is conceptually equivalent with the <code>java.util.Currency.getInstance(String)</code> method.</em>
-   * </p>
+   *  <p>
+   *     <em>This method is conceptually equivalent with the <code>java.util.Currency.getInstance(String)</code> method.</em>
+   *  </p>
    * @param aCurrencyCode a ISO 4217 currency code
    * @return a Currency for aCurrencyCode, or null if aCurrencyCode is null or invalid
    */
-  fromCurrencyCode(aCurrencyCode: string): Currency;
+  fromCurrencyCode(aCurrencyCode: String | string): Currency;
 }
 
 declare namespace CurrencyFactory {}