@sitevision/api 2.0.0-alpha.0 → 2.0.0-alpha.2

package/hidden/senselogic/sitevision/api/date/DateUtil/index.d.ts

@@ -1,153 +0,0 @@
-/**
- * Date utility interface.
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDateUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- * @author Albin Öhrn
- * @since Sitevision 3.5
- */
-
-interface DateUtil {
-  /**
-   * Formats a date according to the ISO8601 specification.
-   *
-   * <p>
-   *    <em>An example:</em> A date representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be
-   *    ISO8601 formatted as <code>2001-02-03T04:05+01:00</code>.
-   * </p>
-   * @param aDate a <code>Date</code> that needs to be formatted
-   * @return the date formatted as a ISO8601 string, or <code>null</code> if <code>aDate</code> is <code>null</code>
-   */
-  getDateAsISO8601String(aDate: java.util.Date): string;
-
-  /**
-   * Formats a calendar according to the ISO8601 specification.
-   *
-   * <p>
-   *    <em>An example:</em> A calendar representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be
-   *    ISO8601 formatted as <code>2001-02-03T04:05+01:00</code>.
-   * </p>
-   * @param aCalendar a <code>Calendar</code> that needs to be formatted
-   * @return aString the calendar date formatted as a ISO8601 string, or <code>null</code> if <code>aCalendar</code> is <code>null</code>
-   */
-  getCalendarAsISO8601String(aCalendar: java.util.Calendar): string;
-
-  /**
-   * Gets the date format pattern used in the Sitevision editor for a specific Locale.
-   * @param aLocale the <code>Locale</code> that specifies the date format pattern
-   * @return the date format pattern used in the Sitevision editor that corresponds to <code>aLocale</code>. If <code>aLocale</code> is <code>null</code> then the current locale (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) is used to locate the format pattern. If no pattern exist for <code>aLocale</code> then the pattern that corresponds to <code>Locale.ENGLISH</code> will be returned.
-   */
-  getEditorFormatPattern(aLocale: java.util.Locale): string;
-
-  /**
-   * Formats a Date according to a <code>SimpleDateFormat</code> pattern.
-   *
-   * <p>
-   *    <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
-   *    If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
-   * </p>
-   * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
-   * @param aDate the Date
-   * @return returns a String representation of aDate according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aDate is null
-   * @see #getDateAsString(String, Date, Locale)
-   */
-  getDateAsString(
-    aFormatPattern: java.lang.String,
-    aDate: java.util.Date
-  ): string;
-
-  /**
-   * Formats a Date according to a <code>SimpleDateFormat</code> pattern using a given Locale.
-   * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
-   * @param aDate the Date
-   * @param aLocale the Locale
-   * @return returns a String representation of aDate according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aDate or aLocale is null
-   * @since Sitevision 8.2
-   */
-  getDateAsString(
-    aFormatPattern: java.lang.String,
-    aDate: java.util.Date,
-    aLocale: java.util.Locale
-  ): string;
-
-  /**
-   * Formats the date of a Calendar according to a <code>SimpleDateFormat</code> pattern.
-   *
-   * <p>
-   *    <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
-   *    If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
-   * </p>
-   * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
-   * @param aCalendar the Calendar
-   * @return returns a String representation of aCalendar according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aCalendar is null
-   * @see #getCalendarAsString(String, Calendar, Locale)
-   */
-  getCalendarAsString(
-    aFormatPattern: java.lang.String,
-    aCalendar: java.util.Calendar
-  ): string;
-
-  /**
-   * Formats the date of a Calendar according to a <code>SimpleDateFormat</code> pattern and a given Locale.
-   * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
-   * @param aCalendar the Calendar
-   * @param aLocale the Locale
-   * @return returns a String representation of aCalendar according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aCalendar or aLocale is null
-   * @since Sitevision 8.2
-   */
-  getCalendarAsString(
-    aFormatPattern: java.lang.String,
-    aCalendar: java.util.Calendar,
-    aLocale: java.util.Locale
-  ): string;
-
-  /**
-   * Converts a Date to a Calendar.
-   * @param aDate a Date
-   * @return a Calendar representing aDate, or null if aDate is null
-   * @since Sitevision 4.5.5
-   */
-  toCalendar(aDate: java.util.Date): unknown;
-
-  /**
-   * Converts a Calendar to a Date.
-   * @param aCalendar a Calendar
-   * @return a Date representing aCalendar, or null if aCalendar is null
-   * @since Sitevision 4.5.5
-   */
-  toDate(aCalendar: java.util.Calendar): unknown;
-
-  /**
-   * Converts a date string to a Date using a <code>SimpleDateFormat</code> pattern.
-   *
-   * <p>
-   *    <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
-   *    If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
-   * </p>
-   * @param aDateStr the string representation of a Date
-   * @param aFormatPattern string to date pattern according to SimpleDateFormat
-   * @return a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern) is null or blank
-   * @since Sitevision 5.1
-   * @see #parseDate(String, String, Locale)
-   */
-  parseDate(
-    aDateStr: java.lang.String,
-    aFormatPattern: java.lang.String
-  ): unknown;
-
-  /**
-   * Converts a date string to a Date using a <code>SimpleDateFormat</code> pattern and a given Locale.
-   * @param aDateStr the string representation of a Date
-   * @param aFormatPattern string to date pattern according to SimpleDateFormat
-   * @param aLocale the Locale
-   * @return a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern, aLocale) is null or blank
-   * @since Sitevision 8.2
-   */
-  parseDate(
-    aDateStr: java.lang.String,
-    aFormatPattern: java.lang.String,
-    aLocale: java.util.Locale
-  ): unknown;
-}

package/hidden/senselogic/sitevision/api/date/TimestampUtil/index.d.ts

@@ -1,121 +0,0 @@
-/**
- * Timestamp utility interface.
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getTimestampUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- * @author Jimmy Roselin
- * @since Sitevision 4.5.4.1
- */
-
-interface TimestampUtil {
-  /**
-   * Returns current timestamp.
-   * @return a long representing the current time.
-   */
-  getTimestamp(): number;
-
-  /**
-   * Formats current timestamp.
-   * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
-   * @return a formatted String representing current timestamp using Locale according to {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}. If aLocale can not be resolved Locale.ENGLISH is used. If aFormatPattern is not valid current timestamp is returned as String.
-   */
-  formatCurrent(aFormatPattern: java.lang.String): string;
-
-  /**
-   * Formats current timestamp using a specified Locale.
-   * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
-   * @param aLocale a locale. If aLocale is null the current locale (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) will be used. If aLocale can not be resolved Locale.ENGLISH will be used.
-   * @return a formatted String representing current timestamp. If aFormatPattern is not valid current timestamp is returned as String.
-   */
-  formatCurrent(
-    aFormatPattern: java.lang.String,
-    aLocale: java.util.Locale
-  ): string;
-
-  /**
-   * Formats a given timestamp.
-   * @param aTimestamp a timestamp.
-   * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
-   * @return a formatted String representing aTimestamp using Locale according to {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}. If aLocale can not be resolved Locale.ENGLISH is used. If aTimestamp is negative or aFormatPattern is not valid the given timestamp is returned as String.
-   */
-  format(aTimestamp: long, aFormatPattern: java.lang.String): string;
-
-  /**
-   * Formats a given timestamp using a specified Locale.
-   * @param aTimestamp a timestamp.
-   * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
-   * @param aLocale a locale. If aLocale is null the current locale (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) will be used. If aLocale can not be resolved Locale.ENGLISH will be used.
-   * @return a formatted String representing the aTimestamp. If aTimestamp is negative or aFormatPattern is not valid the given timestamp is returned as String.
-   */
-  format(
-    aTimestamp: long,
-    aFormatPattern: java.lang.String,
-    aLocale: java.util.Locale
-  ): string;
-
-  /**
-   * Converts a timestamp to a Date.
-   * @param aTimestamp a timestamp.
-   * @return the Date representing aTimestamp, or null if aTimestamp is negative.
-   * @since Sitevision 4.5.5
-   */
-  toDate(aTimestamp: long): unknown;
-
-  /**
-   * Converts a Date to a timestamp.
-   * @param aDate a Date.
-   * @return the timestamp representing aDate, or -1 if aDate is null.
-   * @since Sitevision 4.5.5
-   */
-  fromDate(aDate: java.util.Date): number;
-
-  /**
-   * Converts a timestamp to a Calendar.
-   * @param aTimestamp a timestamp.
-   * @return the Calendar representing aTimestamp, or null if aTimestamp is negative.
-   * @since Sitevision 4.5.5
-   */
-  toCalendar(aTimestamp: long): unknown;
-
-  /**
-   * Converts a Calendar to a timestamp.
-   * @param aCalendar a Calendar.
-   * @return the timestamp representing aCalendar, or -1 if aCalendar is null.
-   * @since Sitevision 4.5.5
-   */
-  fromCalendar(aCalendar: java.util.Calendar): number;
-
-  /**
-   * Converts a timestamp to a Instant.
-   * @param aTimestamp a timestamp.
-   * @return the Instant representing aTimestamp, or null if aTimestamp is negative.
-   * @since Sitevision 4.5.5
-   */
-  toInstant(aTimestamp: long): unknown;
-
-  /**
-   * Converts a Instant to a timestamp.
-   * @param aInstant a Instant.
-   * @return aInstant timestamp representing aInstant, or -1 if aInstant is null.
-   * @since Sitevision 4.5.5
-   */
-  fromInstant(aInstant: java.time.Instant): number;
-
-  /**
-   * Converts a timestamp to a LocalDateTime (using the system default ZoneId).
-   * @param aTimestamp a timestamp.
-   * @return the LocalDateTime representing aTimestamp, or null if aTimestamp is negative.
-   * @since Sitevision 4.5.5
-   */
-  toLocalDateTime(aTimestamp: long): unknown;
-
-  /**
-   * Converts a LocalDateTime to a timestamp (using the system default ZoneId).
-   * @param aLocalDateTime a Instant.
-   * @return aInstant timestamp representing aLocalDateTime, or -1 if aLocalDateTime is null.
-   * @since Sitevision 4.5.5
-   */
-  fromLocalDateTime(aLocalDateTime: java.time.LocalDateTime): number;
-}

package/hidden/senselogic/sitevision/api/device/DeviceUtil/index.d.ts

@@ -1,33 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * Device utility interface.
- *
- * <p>
- * Contains methods for retrieving device-related information.
- * </p>
- *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDeviceUtil()}.
- * 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 3.0
- */
-
-interface DeviceUtil {
-  /**
-   * Checks if current execution/rendering is in a mobile view.
-   * @return <code>true</code> if current execution is rendering in a mobile view, <code>false</code> if not
-   * @deprecated As of Sitevision 10 this method always returns <code>false</code>
-   */
-  isRenderingMobileView(): boolean;
-
-  /**
-   * Checks if currently executing client is a mobile device.
-   * @param aPageNode a page node, typically the currently executing page (see {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentPage()}). Null is allowed but device checking will be more extensive with a proper value since it will also match against all configured devices for the site of the <code>aPageNode</code>.
-   * @return <code>true</code> if currently executing client is a mobile device, <code>false</code> if not
-   * @deprecated As of Sitevision 10 the parameter aPageNode is no longer used
-   */
-  isMobileDevice(aPageNode: Node): boolean;
-}

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

@@ -1,89 +0,0 @@
-import NumericFormatterBuilder from "../NumericFormatterBuilder";
-import Currency from "../../i18n/Currency";
-
-/**
- * Factory for creating formatter builders.
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getFormatterBuilderFactory()}.
- *    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
- */
-
-interface FormatterBuilderFactory {
-  /**
-   * Returns a builder for creating number formatters with a given Locale.
-   *
-   * <p>
-   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
-   *    <code>java.text.NumberFormat.getNumberInstance(aLocale)</code>.</em>
-   * </p>
-   * @param aLocale the Locale
-   * @return a NumericFormatterBuilder that creates number formatters
-   * @throws NullPointerException if aLocale is null
-   */
-  getNumberFormatterBuilder(aLocale: java.util.Locale): NumericFormatterBuilder;
-
-  /**
-   * Returns a builder for creating percent formatters with a given Locale.
-   *
-   * <p>
-   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
-   *    <code>java.text.NumberFormat.getPercentInstance(aLocale)</code>.</em>
-   * </p>
-   * @param aLocale the Locale
-   * @return a NumericFormatterBuilder that creates percent formatters
-   * @throws NullPointerException if aLocale is null
-   */
-  getPercentFormatterBuilder(
-    aLocale: java.util.Locale
-  ): NumericFormatterBuilder;
-
-  /**
-   * Returns a builder for creating currency formatters with a given Locale.
-   *
-   * <p>
-   *    <strong>Currency note!</strong> Currency typically depends on a <em>country</em>. A language-only Locale
-   *    will typically be formatted without any specific currency. Use {@link #getCurrencyFormatterBuilder(Locale, Currency)}
-   *    to actively specify what currency to use when using such locale.
-   * </p>
-   *
-   * <p>
-   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
-   *    <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code>.</em>
-   * </p>
-   * @param aLocale the Locale
-   * @return a NumericFormatterBuilder that creates currency formatters
-   * @throws NullPointerException if aLocale is null
-   * @see #getCurrencyFormatterBuilder(Locale, Currency)
-   */
-  getCurrencyFormatterBuilder(
-    aLocale: java.util.Locale
-  ): NumericFormatterBuilder;
-
-  /**
-   * Returns a builder for creating currency formatters with a given Locale and Currency.
-   *
-   * <p>
-   *    Currency instances are created via methods in {@link senselogic.sitevision.api.i18n.CurrencyFactory}.
-   * </p>
-   *
-   * <p>
-   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
-   *    <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code> with a
-   *    <code>java.util.Currency.getInstance(aCurrencyCode)</code> set.</em>
-   * </p>
-   * @param aLocale the Locale
-   * @param aCurrency the currency
-   * @return a NumericFormatterBuilder that creates currency formatters
-   * @throws NullPointerException if aLocale or aCurrency is null
-   * @see senselogic.sitevision.api.i18n.CurrencyFactory
-   */
-  getCurrencyFormatterBuilder(
-    aLocale: java.util.Locale,
-    aCurrency: Currency
-  ): NumericFormatterBuilder;
-}

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

@@ -1,81 +0,0 @@
-import Currency from "../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>
- * @author Magnus Lövgren
- * @since Sitevision 6.1
- */
-
-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: java.util.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>
-   *
-   * <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: java.lang.String): Currency;
-}