@sitevision/api 1.0.20 → 1.1.0-alpha.1

package/hidden/senselogic/sitevision/api/format/NumericFormatter/index.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Numerical value formatter.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    a builder created via {@link FormatterBuilderFactory}.
+ * </p>Formats a double value.
+ *
+ * <p>
+ *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.format(double)</code>.</em>
+ * </p>Formats a long value.
+ *
+ * <p>
+ *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.format(long)</code>.</em>
+ * </p>Formats a Object value.
+ *
+ * <p>
+ *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.format(Object)</code>.</em>
+ * </p>Parses a source string to a Number.
+ *
+ * <p>
+ *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.parse(String)</code>.</em>
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 6.1
+ */
+interface NumericFormatter {
+  /**
+   * Formats a double value.
+   *
+   * <p>
+   *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.format(double)</code>.</em>
+   * </p>
+   * @param aNumber a double value
+   * @return a formatted result
+   * @throws ArithmeticException if a mathematical operation fails
+   */
+  formatDouble(aNumber: number): string;
+
+  /**
+   * Formats a long value.
+   *
+   * <p>
+   *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.format(long)</code>.</em>
+   * </p>
+   * @param aNumber a long value
+   * @return a formatted result
+   * @throws ArithmeticException if a mathematical operation fails
+   */
+  formatLong(aNumber: number): string;
+
+  /**
+   * Formats a Object value.
+   *
+   * <p>
+   *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.format(Object)</code>.</em>
+   * </p>
+   * @param aObject a Object, typically a java.lang.Number
+   * @return a formatted result
+   * @throws NullPointerException if aObject is null
+   * @throws IllegalArgumentException if aObject is of an unsupported type (e.g. not numerical)
+   * @throws ArithmeticException if a mathematical operation fails
+   */
+  format(aObject: unknown): string;
+
+  /**
+   * Parses a source string to a Number.
+   *
+   * <p>
+   *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.parse(String)</code>.</em>
+   * </p>
+   * @param aSource a string, typically the resulting string from a <em>format</em> operation of a formatter like this
+   * @return the Number object parsed from aSource
+   * @throws NullPointerException if aSource is null
+   * @throws ParseException if parsing of aSource fails
+   */
+  parse(aSource: string): number;
+}
+
+export default NumericFormatter;

package/hidden/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts

@@ -0,0 +1,100 @@
+import NumericFormatter from "../NumericFormatter";
+
+/**
+ * Builder for creating {@link NumericFormatter} instances.
+ *
+ * <p>
+ *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
+ *    more information about Builders and how to work with them!
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link FormatterBuilderFactory}.
+ * </p>Set whether or not grouping will be used in this formatter.
+ *
+ * <p>
+ *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.setGroupingUsed(boolean)</code>.</em>
+ * </p>Sets the minimum number of digits allowed in the integer portion of a number.
+ *
+ * <p>
+ *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.setMinimumIntegerDigits(int)</code>.</em>
+ * </p>Sets the maximum number of digits allowed in the integer portion of a number.
+ *
+ * <p>
+ *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.setMaximumIntegerDigits(int)</code>.</em>
+ * </p>Sets the minimum number of digits allowed in the fraction portion of a number.
+ *
+ * <p>
+ *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.setMinimumFractionDigits(int)</code>.</em>
+ * </p>Sets the maximum number of digits allowed in the fraction portion of a number.
+ *
+ * <p>
+ *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.setMaximumFractionDigits(int)</code>.</em>
+ * </p>Creates a NumericFormatter instance using currently specified state/behaviour.
+ * @author Magnus Lövgren
+ * @since Sitevision 6.1
+ */
+interface NumericFormatterBuilder {
+  /**
+   * Set whether or not grouping will be used in this formatter.
+   *
+   * <p>
+   *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.setGroupingUsed(boolean)</code>.</em>
+   * </p>
+   * @param aUseGrouping true to use grouping, false otherwise
+   * @return this builder
+   */
+  setUseGrouping(aUseGrouping: boolean): NumericFormatterBuilder;
+
+  /**
+   * Sets the minimum number of digits allowed in the integer portion of a number.
+   *
+   * <p>
+   *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.setMinimumIntegerDigits(int)</code>.</em>
+   * </p>
+   * @param aMinIntegerDigits the minimum number of integer digits to be shown
+   * @return this builder
+   */
+  setMinIntegerDigits(aMinIntegerDigits: number): NumericFormatterBuilder;
+
+  /**
+   * Sets the maximum number of digits allowed in the integer portion of a number.
+   *
+   * <p>
+   *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.setMaximumIntegerDigits(int)</code>.</em>
+   * </p>
+   * @param aMaxIntegerDigits the maximum number of integer digits to be shown
+   * @return this builder
+   */
+  setMaxIntegerDigits(aMaxIntegerDigits: number): NumericFormatterBuilder;
+
+  /**
+   * Sets the minimum number of digits allowed in the fraction portion of a number.
+   *
+   * <p>
+   *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.setMinimumFractionDigits(int)</code>.</em>
+   * </p>
+   * @param aMinFractionDigits the minimum number of fraction digits to be shown
+   * @return this builder
+   */
+  setMinFractionDigits(aMinFractionDigits: number): NumericFormatterBuilder;
+
+  /**
+   * Sets the maximum number of digits allowed in the fraction portion of a number.
+   *
+   * <p>
+   *    <em>This method is conceptually equivalent with <code>java.text.NumberFormat.setMaximumFractionDigits(int)</code>.</em>
+   * </p>
+   * @param aMaxFractionDigits the maximum number of fraction digits to be shown
+   * @return this builder
+   */
+  setMaxFractionDigits(aMaxFractionDigits: number): NumericFormatterBuilder;
+
+  /**
+   * Creates a NumericFormatter instance using currently specified state/behaviour.
+   * @return a numeric formatter
+   */
+  build(): NumericFormatter;
+}
+
+export default NumericFormatterBuilder;

package/hidden/senselogic/sitevision/api/i18n/Currency/index.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Representation of a currency.
+ *
+ * <p>
+ *    <em>This interface is conceptually equivalent with the <code>java.util.Currency</code> class.</em>
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface is obtained via {@link CurrencyFactory}.
+ * </p>Gets the ISO 4217 currency code of this currency.
+ *
+ * <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>Gets the name that is suitable for displaying this currency for a specified locale.
+ *
+ * If there is no suitable display name found for the specified locale, the ISO 4217 currency code is returned.Gets the symbol of this currency for a specified locale.
+ *
+ * For example, for the US Dollar, the symbol is "$" if the specified
+ * locale is the US, while for other locales it may be "US$".
+ *
+ * If no symbol can be determined, the ISO 4217 currency code is returned.
+ * @author Magnus Lövgren
+ * @since Sitevision 6.1
+ */
+interface Currency {
+  /**
+   * Gets the ISO 4217 currency code of this currency.
+   *
+   * <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>
+   * @return the ISO 4217 currency code of this currency.
+   */
+  getCurrencyCode(): string;
+
+  /**
+   * Gets the name that is suitable for displaying this currency for a specified locale.
+   *
+   * If there is no suitable display name found for the specified locale, the ISO 4217 currency code is returned.
+   * @param aLocale the locale to use for display of this currency
+   * @return the display name of this currency for aLocale
+   * @throws NullPointerException if aLocale is null
+   */
+  getDisplayName(aLocale: unknown): string;
+
+  /**
+   * Gets the symbol of this currency for a specified locale.
+   *
+   * For example, for the US Dollar, the symbol is "$" if the specified
+   * locale is the US, while for other locales it may be "US$".
+   *
+   * If no symbol can be determined, the ISO 4217 currency code is returned.
+   * @param aLocale the locale to use for display of the symbol of this currency
+   * @return the symbol of this currency for aLocale
+   * @throws NullPointerException if aLocale is null
+   */
+  getSymbol(aLocale: unknown): string;
+}
+
+export default Currency;

package/hidden/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts

@@ -0,0 +1,45 @@
+import CustomLinkRenderData from "../CustomLinkRenderData";
+
+/**
+ * Custom link processor interface that enables custom validation and data attributes rendering for specific link URLs.Validates a link URL accepted by this link processor.
+ *
+ * <p>
+ *    Note! This method will only be called if {@link senselogic.sitevision.api.base.Filter#accept(Object)}
+ *    returns <code>true</code> for <code>aLinkURL</code>.
+ * </p>Gets custom render data for a link URL accepted by this link processor.
+ *
+ * <p>
+ *    Note! This method will only be called if {@link senselogic.sitevision.api.base.Filter#accept(Object)}
+ *    returns <code>true</code> for <code>aLinkURL</code>.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 4.0.4
+ */
+interface CustomLinkProcessor {
+  /**
+   * Validates a link URL accepted by this link processor.
+   *
+   * <p>
+   *    Note! This method will only be called if {@link senselogic.sitevision.api.base.Filter#accept(Object)}
+   *    returns <code>true</code> for <code>aLinkURL</code>.
+   * </p>
+   * @param aLinkURL the link URL to validate
+   * @param aLocale the Locale to use for potential validation error message
+   * @return a localized validation error message, or <code>null</code> if validation passes
+   */
+  validate(aLinkURL: string, aLocale: unknown): string;
+
+  /**
+   * Gets custom render data for a link URL accepted by this link processor.
+   *
+   * <p>
+   *    Note! This method will only be called if {@link senselogic.sitevision.api.base.Filter#accept(Object)}
+   *    returns <code>true</code> for <code>aLinkURL</code>.
+   * </p>
+   * @param aLinkURL the link URL that should be rendered
+   * @return custom render data, or <code>null</code> if no custom render data is to be used
+   */
+  getRenderData(aLinkURL: string): CustomLinkRenderData;
+}
+
+export default CustomLinkProcessor;

package/hidden/senselogic/sitevision/api/link/CustomLinkRenderData/index.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Custom link data that enables custom data attributes when rendering for specific link URLs.Returns the data attributes that should be used when rendering a link accepted by the {@link CustomLinkProcessor}.
+ *
+ * <p>
+ *    Notes about entry <em>keys</em>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       A key that is <code>null</code> or <em>whitespace-only</em> will be completely ignored, i.e. no data attribute will be rendered.
+ *    </li>
+ *    <li>
+ *       A key that isn't properly prefixed with <em>"data-"</em> will be prefixed when the data attribute is rendered.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    Notes about entry <em>values</em>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       A value that is <code>null</code> or <em>whitespace-only</em> will be rendered as a data attribute without value.
+ *    </li>
+ *    <li>
+ *       A value should not be escaped, it will be escaped when it is rendered
+ *       (typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)}).
+ *    </li>
+ * </ul>
+ * @author Magnus Lövgren
+ * @since Sitevision 4.0.4
+ * @see CustomLinkProcessor#getRenderData(String)
+ */
+interface CustomLinkRenderData {
+  /**
+   * Returns the data attributes that should be used when rendering a link accepted by the {@link CustomLinkProcessor}.
+   *
+   * <p>
+   *    Notes about entry <em>keys</em>:
+   * </p>
+   * <ul>
+   *    <li>
+   *       A key that is <code>null</code> or <em>whitespace-only</em> will be completely ignored, i.e. no data attribute will be rendered.
+   *    </li>
+   *    <li>
+   *       A key that isn't properly prefixed with <em>"data-"</em> will be prefixed when the data attribute is rendered.
+   *    </li>
+   * </ul>
+   *
+   * <p>
+   *    Notes about entry <em>values</em>:
+   * </p>
+   * <ul>
+   *    <li>
+   *       A value that is <code>null</code> or <em>whitespace-only</em> will be rendered as a data attribute without value.
+   *    </li>
+   *    <li>
+   *       A value should not be escaped, it will be escaped when it is rendered
+   *       (typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)}).
+   *    </li>
+   * </ul>
+   * @return the data attributes that should be used when rendering a link accepted by the {@link CustomLinkProcessor}
+   */
+  getDataAttributes(): Record<unknown, unknown>;
+}
+
+export default CustomLinkRenderData;

package/hidden/senselogic/sitevision/api/mail/Mail/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Mail to be sent.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.mail.MailBuilder#build()}.
+ *    See {@link senselogic.sitevision.api.mail.MailBuilder} for how to obtain an instance of the <code>MailBuilder</code> interface.
+ * </p>Sends this mail synchronously.Sends this mail asynchronously.
+ *
+ * No information is returned to as if the mail was really sent as far as the actual mail server (whose configuration is specified on the
+ * Sitevision server node). The mail might be queued, quarantined or silently ignored by the mail server.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ * @see senselogic.sitevision.api.mail.MailBuilder
+ */
+interface Mail {
+  /**
+   * Sends this mail synchronously.
+   * @return <code>true</code> if no error was reported from the Sitevision mail service, <code>false</code> otherwise. <strong><em>Important node!</em></strong> A <code>true</code> value implies that the mail is sent as far as the Sitevision mail service can tell, but it doesn't guarantee that the actual mail server (whose configuration is specified on the Sitevision server node) has done so. The mail might be queued, quarantined or silently ignored by the mail server.
+   */
+  send(): boolean;
+
+  /**
+   * Sends this mail asynchronously.
+   *
+   * No information is returned to as if the mail was really sent as far as the actual mail server (whose configuration is specified on the
+   * Sitevision server node). The mail might be queued, quarantined or silently ignored by the mail server.
+   * @since Sitevision 2022.05.1
+   */
+  sendAsync(): void;
+}
+
+export default Mail;

package/hidden/senselogic/sitevision/api/message/MessageTextLinker/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Message text rendering interface that detects and creates links in plain message texts.Creates links found in plain message text.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.0.2
+ */
+interface MessageTextLinker {
+  /**
+   * Creates links found in plain message text.
+   * @param aText the text that might contain links
+   * @return a linked text, or empty string if <code>aText</code> is <code>null</code>
+   */
+  autoLink(aText: string): string;
+}
+
+export default MessageTextLinker;

package/hidden/senselogic/sitevision/api/metadata/value/LinkValue/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * A temporary representation of a link metadata value.
+ *
+ * <p>
+ *    An instance of this interface can be used in MetadataUtil when setting a link metadata via the
+ *    {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, String, Object)}
+ *    or
+ *    {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property, Object)}
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.metadata.builder.LinkValueBuilder#build()}.
+ *    See {@link senselogic.sitevision.api.metadata.builder.LinkValueBuilder} for how to obtain an instance of the
+ *    <code>LinkValueBuilder</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ * @see senselogic.sitevision.api.metadata.builder.LinkValueBuilder
+ */
+interface LinkValue {}
+
+export default LinkValue;

package/hidden/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * A temporary representation of a related metadata value.
+ *
+ * <p>
+ *    An instance of this interface can be used in MetadataUtil when setting a related metadata via the
+ *    {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, String, Object)}
+ *    or
+ *    {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property, Object)}
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.metadata.builder.RelatedValueBuilder#build()}.
+ *    See {@link senselogic.sitevision.api.metadata.builder.RelatedValueBuilder} for how to obtain an instance of the
+ *    <code>RelatedValueBuilder</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ * @see senselogic.sitevision.api.metadata.builder.RelatedValueBuilder
+ */
+interface RelatedValue {}
+
+export default RelatedValue;