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

package/server/ColorUtil/index.d.ts

@@ -1,38 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * Gets the color with a given name
- * @param aColorName the name of the font
- * @return the first color with name aColorName, or <code>null</code> if no color matches
- */
-export function getColorByName(aColorName: string): Node;
-
-/**
- * Gets the color with a given name with a fallback value if no color matches
- * @param aColorName the name of the font
- * @param aDefaultValue fallback value
- * @return the first color with name aColorName, or aDefaultValue if no color matches
- */
-export function getColorByName(aColorName: 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
- */
-export function getColorByHtmlHexValue(aHexString: 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.
- * @param aHexString the hex string value of the font (starts with a '#' and ends with 6 characters [0-9,a-f,A-F])
- * @param aDefaultValue fallback value
- * @return the first color with the corresponding hex string, or aDefaultValue if no color matches
- */
-export function getColorByHtmlHexValue(
-  aHexString: string,
-  aDefaultValue: Node
-): Node;
-
 /**
  * Utility interface for Colors.
  *
@@ -42,8 +9,40 @@ export function getColorByHtmlHexValue(
  * </p>
  * @author Magnus Lövgren
  */
-declare namespace colorUtil {
-  export { getColorByName, getColorByHtmlHexValue };
+export interface ColorUtil {
+  /**
+   * Gets the color with a given name
+   * @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;
+
+  /**
+   * Gets the color with a given name with a fallback value if no color matches
+   * @param aColorName the name of the font
+   * @param aDefaultValue fallback value
+   * @return the first color with name aColorName, or aDefaultValue if no color matches
+   */
+  getColorByName(aColorName: 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;
+
+  /**
+   * 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.
+   * @param aHexString the hex string value of the font (starts with a '#' and ends with 6 characters [0-9,a-f,A-F])
+   * @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;
 }
 
+declare namespace ColorUtil {}
+
+declare var colorUtil: ColorUtil;
+
 export default colorUtil;

package/server/CompoundAndFilterBuilder/index.d.ts

@@ -1,30 +1,6 @@
 import type { Filter } from "../../types/senselogic/sitevision/api/base/Filter";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/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>
- * @param aFilter the node filter to add, <code>null</code> will be ignored
- * @return this builder
- */
-export function addFilter(aFilter: Filter): CompoundAndFilterBuilder;
-
-/**
- * Removes all previously added filters.
- * @return this builder
- */
-export function clearFilters(): CompoundAndFilterBuilder;
-
-/**
- * Creates a node filter instance that will perform the <em>AND</em> operation for all currently specified filters.
- * @return a node filter
- * @throws IllegalStateException if this builder contains no filters.
- */
-export function build(): Filter;
-
 /**
  * Builds a compound filter that requires that <em>all</em> added filters matches.
  *
@@ -50,8 +26,34 @@ export function build(): Filter;
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */
-declare namespace compoundAndFilterBuilder {
-  export { addFilter, clearFilters, build };
+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>
+   * @param aFilter the node filter to add, <code>null</code> will be ignored
+   * @return this builder
+   */
+  addFilter(aFilter: Filter): CompoundAndFilterBuilder;
+
+  /**
+   * Removes all previously added filters.
+   * @return this builder
+   */
+  clearFilters(): CompoundAndFilterBuilder;
+
+  /**
+   * Creates a node filter instance that will perform the <em>AND</em> operation for all currently specified filters.
+   * @return a node filter
+   * @throws IllegalStateException if this builder contains no filters.
+   */
+  build(): Filter;
 }
 
+declare namespace CompoundAndFilterBuilder {}
+
+declare var compoundAndFilterBuilder: CompoundAndFilterBuilder;
+
 export default compoundAndFilterBuilder;

package/server/CompoundComparatorBuilder/index.d.ts

@@ -1,34 +1,5 @@
 import type { Builder } from "../../types/senselogic/sitevision/api/base/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>
- * @param aComparator the node comparator to add, <code>null</code> will be ignored
- * @return this builder
- */
-export function addComparator(aComparator: unknown): CompoundComparatorBuilder;
-
-/**
- * Removes all previously added comparators.
- * @return this builder
- */
-export function clearComparators(): CompoundComparatorBuilder;
-
-/**
- * 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>
- * @return a node comparator
- * @throws IllegalStateException if this builder contains no comparators.
- */
-export function build(): unknown;
-
 /**
  * Builds a compound comparator that allows comparison based on multiple comparators.
  *
@@ -49,8 +20,39 @@ export function build(): unknown;
  * @author Magnus Lövgren
  * @since Sitevision 3.6.3
  */
-declare namespace compoundComparatorBuilder {
-  export { addComparator, clearComparators, build };
+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>
+   * @param aComparator the node comparator to add, <code>null</code> will be ignored
+   * @return this builder
+   */
+  addComparator(aComparator: unknown): CompoundComparatorBuilder;
+
+  /**
+   * Removes all previously added comparators.
+   * @return this builder
+   */
+  clearComparators(): CompoundComparatorBuilder;
+
+  /**
+   * 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>
+   * @return a node comparator
+   * @throws IllegalStateException if this builder contains no comparators.
+   */
+  build(): unknown;
 }
 
+declare namespace CompoundComparatorBuilder {}
+
+declare var compoundComparatorBuilder: CompoundComparatorBuilder;
+
 export default compoundComparatorBuilder;

package/server/CompoundOrFilterBuilder/index.d.ts

@@ -1,30 +1,6 @@
 import type { Filter } from "../../types/senselogic/sitevision/api/base/Filter";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/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>
- * @param aFilter the node filter to add, <code>null</code> will be ignored
- * @return this builder
- */
-export function addFilter(aFilter: Filter): CompoundOrFilterBuilder;
-
-/**
- * Removes all previously added filters.
- * @return this builder
- */
-export function clearFilters(): CompoundOrFilterBuilder;
-
-/**
- * Creates a node filter instance that will perform the <em>OR</em> operation for all currently specified filters.
- * @return a node filter
- * @throws IllegalStateException if this builder contains no filters.
- */
-export function build(): Filter;
-
 /**
  * Builds a compound filter that requires that <em>any</em> of the added filters matches.
  *
@@ -49,8 +25,34 @@ export function build(): Filter;
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */
-declare namespace compoundOrFilterBuilder {
-  export { addFilter, clearFilters, build };
+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>
+   * @param aFilter the node filter to add, <code>null</code> will be ignored
+   * @return this builder
+   */
+  addFilter(aFilter: Filter): CompoundOrFilterBuilder;
+
+  /**
+   * Removes all previously added filters.
+   * @return this builder
+   */
+  clearFilters(): CompoundOrFilterBuilder;
+
+  /**
+   * Creates a node filter instance that will perform the <em>OR</em> operation for all currently specified filters.
+   * @return a node filter
+   * @throws IllegalStateException if this builder contains no filters.
+   */
+  build(): Filter;
 }
 
+declare namespace CompoundOrFilterBuilder {}
+
+declare var compoundOrFilterBuilder: CompoundOrFilterBuilder;
+
 export default compoundOrFilterBuilder;

package/server/ContentNodeUtil/index.d.ts

@@ -1,35 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * 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>
- * @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
- */
-export function 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>
- *    <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
- */
-export function getContentParent(aContentNode: Node): Node;
-
 /**
  * Content Node utility interface.
  *
@@ -53,8 +23,40 @@ export function getContentParent(aContentNode: Node): Node;
  * @author Magnus Lövgren
  * @since Sitevision 10.2
  */
-declare namespace contentNodeUtil {
-  export { getRenderableParent, getContentParent };
+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>
+   * @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
+   */
+  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>
+   *    <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
+   */
+  getContentParent(aContentNode: Node): Node;
 }
 
+declare namespace ContentNodeUtil {}
+
+declare var contentNodeUtil: ContentNodeUtil;
+
 export default contentNodeUtil;

package/server/CurrencyFactory/index.d.ts

@@ -1,71 +1,5 @@
 import type { Currency } from "../../types/senselogic/sitevision/api/i18n/Currency";
 
-/**
- * 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>
- *    <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)
- */
-export function fromLocale(aLocale: unknown): 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>
- *
- * <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>
- * @param aCurrencyCode a ISO 4217 currency code
- * @return a Currency for aCurrencyCode, or null if aCurrencyCode is null or invalid
- */
-export function fromCurrencyCode(aCurrencyCode: string): Currency;
-
 /**
  * Factory for creating Currency instances.
  *
@@ -77,8 +11,76 @@ export function fromCurrencyCode(aCurrencyCode: string): Currency;
  * @author Magnus Lövgren
  * @since Sitevision 6.1
  */
-declare namespace currencyFactory {
-  export { fromLocale, fromCurrencyCode };
+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>
+   *    <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;
+
+  /**
+   * 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>
+   *
+   * <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>
+   * @param aCurrencyCode a ISO 4217 currency code
+   * @return a Currency for aCurrencyCode, or null if aCurrencyCode is null or invalid
+   */
+  fromCurrencyCode(aCurrencyCode: string): Currency;
 }
 
+declare namespace CurrencyFactory {}
+
+declare var currencyFactory: CurrencyFactory;
+
 export default currencyFactory;