@sitevision/api 1.0.20 → 1.1.0-alpha.1

package/server/ColorUtil/index.d.ts

@@ -1,44 +1,49 @@
-import Node from '../../builtins/Node';
+import Node from "../../hidden/javax/jcr/Node";
 
 /**
  * Gets the color with a given name
- *
- * @param {string} aColorName the name of the font
- * @return {Node} the first color with name aColorName, or <code>null</code> if no color matches
+ * @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 {string} aColorName the name of the font
- * @param {Node} aDefaultValue fallback value
- * @return {Node} the first color with name aColorName, or aDefaultValue 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 {string} aHexString the hex string value of the font (starts with a '#' and ends with 6 characters [0-9,a-f,A-F])
- * @return {Node} the first color with the corresponding hex string, or <code>null</code> 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])
+ * @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 {string} aHexString the hex string value of the font (starts with a '#' and ends with 6 characters [0-9,a-f,A-F])
- * @param {Node} aDefaultValue fallback value
- * @return {Node} the first color with the corresponding hex string, or aDefaultValue 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;
 
-declare namespace colorUtil {
+/**
+ * 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>Gets the color with a given nameGets the color with a given name with a fallback value if no color matchesGets the color with a given html hex value (i.e. a '#' followed by 6 characters [0-9,a-f,A-F]).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.
+ * @author Magnus Lövgren
+ */
+declare namespace ColorUtil {
   export { getColorByName, getColorByHtmlHexValue };
 }
 
-export default colorUtil;
+export default ColorUtil;

package/server/CompoundAndFilterBuilder/index.d.ts

@@ -0,0 +1,60 @@
+import Filter from "../../hidden/senselogic/sitevision/api/base/Filter";
+
+/**
+ * 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.
+ *
+ * <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>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>Removes all previously added filters.Creates a node filter instance that will perform the <em>AND</em> operation for all currently specified filters.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.2
+ */
+declare namespace CompoundAndFilterBuilder {
+  export { addFilter, clearFilters, build };
+}
+
+export default CompoundAndFilterBuilder;

package/server/CompoundComparatorBuilder/index.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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.
+ *
+ * <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>
+ *    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>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>Removes all previously added comparators.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>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.3
+ */
+declare namespace CompoundComparatorBuilder {
+  export { addComparator, clearComparators, build };
+}
+
+export default CompoundComparatorBuilder;

package/server/CompoundOrFilterBuilder/index.d.ts

@@ -0,0 +1,59 @@
+import Filter from "../../hidden/senselogic/sitevision/api/base/Filter";
+
+/**
+ * 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.
+ *
+ * <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>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>Removes all previously added filters.Creates a node filter instance that will perform the <em>OR</em> operation for all currently specified filters.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.2
+ */
+declare namespace CompoundOrFilterBuilder {
+  export { addFilter, clearFilters, build };
+}
+
+export default CompoundOrFilterBuilder;

package/server/ContentNodeUtil/index.d.ts

@@ -0,0 +1,76 @@
+import Node from "../../hidden/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.
+ *
+ * <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>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>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>
+ * @author Magnus Lövgren
+ * @since Sitevision 10.2
+ */
+declare namespace ContentNodeUtil {
+  export { getRenderableParent, getContentParent };
+}
+
+export default ContentNodeUtil;

package/server/CurrencyFactory/index.d.ts

@@ -0,0 +1,135 @@
+import Currency from "../../hidden/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.
+ *
+ * <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>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>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>
+ * @author Magnus Lövgren
+ * @since Sitevision 6.1
+ */
+declare namespace CurrencyFactory {
+  export { fromLocale, fromCurrencyCode };
+}
+
+export default CurrencyFactory;