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

package/server/TimestampUtil/index.d.ts

@@ -1,133 +1,119 @@
 /**
- * Returns current timestamp.
- * @return a long representing the current time.
+ * 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
  */
-export function getTimestamp(): number;
+export 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.
- */
-export function formatCurrent(aFormatPattern: string): string;
+  /**
+   * 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: 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.
- */
-export function formatCurrent(aFormatPattern: string, aLocale: unknown): 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: string, aLocale: unknown): 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.
- */
-export function format(aTimestamp: number, aFormatPattern: string): 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: number, aFormatPattern: 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.
- */
-export function format(
-  aTimestamp: number,
-  aFormatPattern: string,
-  aLocale: unknown
-): 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: number, aFormatPattern: string, aLocale: unknown): 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
- */
-export function toDate(aTimestamp: number): unknown;
+  /**
+   * 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: number): 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
- */
-export function fromDate(aDate: unknown): number;
+  /**
+   * 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: unknown): 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
- */
-export function toCalendar(aTimestamp: number): unknown;
+  /**
+   * 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: number): 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
- */
-export function fromCalendar(aCalendar: unknown): number;
+  /**
+   * 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: unknown): 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
- */
-export function toInstant(aTimestamp: number): unknown;
+  /**
+   * 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: number): 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
- */
-export function fromInstant(aInstant: unknown): number;
+  /**
+   * 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: unknown): 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
- */
-export function toLocalDateTime(aTimestamp: number): unknown;
+  /**
+   * 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: number): 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
- */
-export function fromLocalDateTime(aLocalDateTime: unknown): number;
-
-/**
- * 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
- */
-declare namespace timestampUtil {
-  export {
-    getTimestamp,
-    formatCurrent,
-    format,
-    toDate,
-    fromDate,
-    toCalendar,
-    fromCalendar,
-    toInstant,
-    fromInstant,
-    toLocalDateTime,
-    fromLocalDateTime,
-  };
+  /**
+   * 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: unknown): number;
 }
 
-export default timestampUtil;
+declare namespace TimestampUtil {}
+
+declare var timestampUtil: TimestampUtil;
+
+export = timestampUtil;

package/server/TranslationUtil/index.d.ts

@@ -1,99 +1,4 @@
-import type { Node } from "../../types/javax/jcr/Node";
-
-/**
- * Gets a list of all Locales that are set up for translations on the current site.
- *
- * <p>
- *    <em>Note! The returned List is immutable/unmodifiable,
- *    i.e. you must create a copy if you want to modify it (e.g. sort).</em>
- * </p>
- * @return a list of all Locales that are set up for translations on the current site
- */
-export function getSiteTranslationLocales(): unknown;
-
-/**
- * Gets the translation mappings for a given page node.
- *
- * <p>
- *    Each entry in the returned map depicts a <em>"translation"</em>, i.e. a localized version of the given <code>aPageNode</code>.
- * </p>
- * <p>
- *    <strong>Important note! The returned map is never null, but entry <em>values</em> in the map might be!</strong>
- * </p>
- * <ul>
- *    <li>
- *       The entry <em>key</em> (i.e. the Locale) will never be null.
- *    </li>
- *    <li>
- *       The entry <em>value</em> (i.e. the Node) will be null if current user doesn't have
- *       {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} permissions on the node.
- *    </li>
- * </ul>
- *
- * <p>
- *    <em>Tip!</em> If you are only interested in non-null Nodes/values in the returned map, you can use
- *    {@link senselogic.sitevision.api.node.NodeFilterUtil} to filter them out!<br>
- *       Below is a conceptual example of how it could be done in server-side JavaScript (e.g. WebApp, RESTApp, Script module).
- * </p><pre><code>    var thePotentiallyTranslatedPageNode = ...,
- *        translationUtil = require('TranslationUtil'),
- *        nodeFilterUtil = require('NodeFilterUtil'),
- *        translationMappings,
- *        skipNullValuesFilter,
- *        filteredTranslationMappings;
- *
- *    translationMappings = translationUtil.getTranslations(thePotentiallyTranslatedPageNode, false);
- *
- *    skipNullValuesFilter = nodeFilterUtil.getNonNullFilter();
- *    filteredTranslationMappings = nodeFilterUtil.getFilteredValueMap(translationMappings, skipNullValuesFilter);</code></pre>
- *
- * <p>
- *    Please note that determining the "<em>is this page node translated at all?</em>" state from the returned result
- *    depends on the <code>aIncludePageNode</code> value:
- * </p>
- * <ul>
- *    <li>
- *       If it is <code>false</code>, an empty map will be returned.
- *    </li>
- *    <li>
- *       If it is <code>true</code>, a map with one entry <em>(i.e. the <code>aPageNode</code> itself)</em> will be returned.
- *    </li>
- * </ul>
- * @param aPageNode a page node that can be translated
- * @param aIncludePageNode whether or not to include aPageNode in the result
- * @return a Map of translation mappings
- * @since Sitevision 4.3.1
- */
-export function getTranslations(
-  aPageNode: Node,
-  aIncludePageNode: boolean
-): unknown;
-
-/**
- * Gets the page node a given node is potentially translated from (the translation source).
- * @param aPageNode the page node that is translated
- * @return the page node aPageNode was translated from, or null if the page node isn't translated from another page or if current user doesn't have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} permissions on the from node.
- * @since Sitevision 4.3.1
- */
-export function getTranslatedFrom(aPageNode: Node): Node;
-
-/**
- * Sets the translated from node to the page node provided as translation node.
- *
- * <p>
- *    <strong>Permission note!</strong> Current user must match have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_TRANSLATIONS} and
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
- *    on @aTranslationPageNode.
- * </p>
- * @param aOriginalPageNode the original page node to be configured as translated from on aTranslationPageNode. It will be configured as original in aTranslationPageNode as well if aOriginalPageNode doesn't have any original configured.
- * @param aTranslationPageNode the translation page node to be configured as translation of aOriginalPageNode
- * @return true if aTranslationPageNode could be configured as translation of aOriginalPageNode, false otherwise.
- * @since Sitevision 4.3.2
- */
-export function setTranslatedFrom(
-  aOriginalPageNode: Node,
-  aTranslationPageNode: Node
-): boolean;
+import type Node from "../../types/javax/jcr/Node";
 
 /**
  * Translation utility interface.
@@ -106,13 +11,102 @@ export function setTranslatedFrom(
  * @author Magnus Lövgren
  * @since Sitevision 4.2.1
  */
-declare namespace translationUtil {
-  export {
-    getSiteTranslationLocales,
-    getTranslations,
-    getTranslatedFrom,
-    setTranslatedFrom,
-  };
+export interface TranslationUtil {
+  /**
+   * Gets a list of all Locales that are set up for translations on the current site.
+   *
+   * <p>
+   *    <em>Note! The returned List is immutable/unmodifiable,
+   *    i.e. you must create a copy if you want to modify it (e.g. sort).</em>
+   * </p>
+   * @return a list of all Locales that are set up for translations on the current site
+   */
+  getSiteTranslationLocales(): unknown;
+
+  /**
+   * Gets the translation mappings for a given page node.
+   *
+   * <p>
+   *    Each entry in the returned map depicts a <em>"translation"</em>, i.e. a localized version of the given <code>aPageNode</code>.
+   * </p>
+   * <p>
+   *    <strong>Important note! The returned map is never null, but entry <em>values</em> in the map might be!</strong>
+   * </p>
+   * <ul>
+   *    <li>
+   *       The entry <em>key</em> (i.e. the Locale) will never be null.
+   *    </li>
+   *    <li>
+   *       The entry <em>value</em> (i.e. the Node) will be null if current user doesn't have
+   *       {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} permissions on the node.
+   *    </li>
+   * </ul>
+   *
+   * <p>
+   *    <em>Tip!</em> If you are only interested in non-null Nodes/values in the returned map, you can use
+   *    {@link senselogic.sitevision.api.node.NodeFilterUtil} to filter them out!<br>
+   *       Below is a conceptual example of how it could be done in server-side JavaScript (e.g. WebApp, RESTApp, Script module).
+   * </p><pre><code>    var thePotentiallyTranslatedPageNode = ...,
+   *        translationUtil = require('TranslationUtil'),
+   *        nodeFilterUtil = require('NodeFilterUtil'),
+   *        translationMappings,
+   *        skipNullValuesFilter,
+   *        filteredTranslationMappings;
+   *
+   *    translationMappings = translationUtil.getTranslations(thePotentiallyTranslatedPageNode, false);
+   *
+   *    skipNullValuesFilter = nodeFilterUtil.getNonNullFilter();
+   *    filteredTranslationMappings = nodeFilterUtil.getFilteredValueMap(translationMappings, skipNullValuesFilter);</code></pre>
+   *
+   * <p>
+   *    Please note that determining the "<em>is this page node translated at all?</em>" state from the returned result
+   *    depends on the <code>aIncludePageNode</code> value:
+   * </p>
+   * <ul>
+   *    <li>
+   *       If it is <code>false</code>, an empty map will be returned.
+   *    </li>
+   *    <li>
+   *       If it is <code>true</code>, a map with one entry <em>(i.e. the <code>aPageNode</code> itself)</em> will be returned.
+   *    </li>
+   * </ul>
+   * @param aPageNode a page node that can be translated
+   * @param aIncludePageNode whether or not to include aPageNode in the result
+   * @return a Map of translation mappings
+   * @since Sitevision 4.3.1
+   */
+  getTranslations(aPageNode: Node, aIncludePageNode: boolean): unknown;
+
+  /**
+   * Gets the page node a given node is potentially translated from (the translation source).
+   * @param aPageNode the page node that is translated
+   * @return the page node aPageNode was translated from, or null if the page node isn't translated from another page or if current user doesn't have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} permissions on the from node.
+   * @since Sitevision 4.3.1
+   */
+  getTranslatedFrom(aPageNode: Node): Node;
+
+  /**
+   * Sets the translated from node to the page node provided as translation node.
+   *
+   * <p>
+   *    <strong>Permission note!</strong> Current user must match have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_TRANSLATIONS} and
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
+   *    on @aTranslationPageNode.
+   * </p>
+   * @param aOriginalPageNode the original page node to be configured as translated from on aTranslationPageNode. It will be configured as original in aTranslationPageNode as well if aOriginalPageNode doesn't have any original configured.
+   * @param aTranslationPageNode the translation page node to be configured as translation of aOriginalPageNode
+   * @return true if aTranslationPageNode could be configured as translation of aOriginalPageNode, false otherwise.
+   * @since Sitevision 4.3.2
+   */
+  setTranslatedFrom(
+    aOriginalPageNode: Node,
+    aTranslationPageNode: Node
+  ): boolean;
 }
 
-export default translationUtil;
+declare namespace TranslationUtil {}
+
+declare var translationUtil: TranslationUtil;
+
+export = translationUtil;