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

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

@@ -0,0 +1,121 @@
+/**
+ * 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

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,89 @@
+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/format/NumericFormatter/index.d.ts

@@ -4,22 +4,6 @@
  * <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

package/hidden/senselogic/sitevision/api/format/NumericFormatter/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  formatDouble: function formatDouble() {},
+  formatLong: function formatLong() {},
+  format: function format() {},
+  parse: function parse() {}
+};
+exports["default"] = _default;

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

@@ -1,4 +1,5 @@
 import NumericFormatter from "../NumericFormatter";
+import Builder from "../../base/Builder";
 
 /**
  * Builder for creating {@link NumericFormatter} instances.
@@ -10,27 +11,7 @@ import NumericFormatter from "../NumericFormatter";
  *
  * <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.
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 6.1
  */

package/hidden/senselogic/sitevision/api/format/NumericFormatterBuilder/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  setUseGrouping: function setUseGrouping() {},
+  setMinIntegerDigits: function setMinIntegerDigits() {},
+  setMaxIntegerDigits: function setMaxIntegerDigits() {},
+  setMinFractionDigits: function setMinFractionDigits() {},
+  setMaxFractionDigits: function setMaxFractionDigits() {},
+  build: function build() {}
+};
+exports["default"] = _default;

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

@@ -7,48 +7,7 @@
  *
  * <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
  */

package/hidden/senselogic/sitevision/api/i18n/Currency/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getCurrencyCode: function getCurrencyCode() {},
+  getDisplayName: function getDisplayName() {},
+  getSymbol: function getSymbol() {}
+};
+exports["default"] = _default;

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

@@ -0,0 +1,81 @@
+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;
+}