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

package/hidden/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts

@@ -1,6 +1,6 @@
 import Node from "../../../../../javax/jcr/Node";
-import CollaborationGroupType from "../../../../../../server/CollaborationGroupType";
-import CollaborationGroupState from "../../../../../../server/CollaborationGroupState";
+
+import Wrapper from "../../base/Wrapper";
 
 /**
  * Collaboration group administration interface.
@@ -14,128 +14,6 @@ import CollaborationGroupState from "../../../../../../server/CollaborationGroup
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link CollaborationFactory#getCollaborationGroupWrapper(javax.jcr.Node)}.
  *    See {@link CollaborationFactory} for how to obtain an instance of the <code>CollaborationFactory</code> interface.
- * </p>Gets the admins of the wrapped collaboration group.Checks if a user identity is admin of the wrapped collaboration group.Adds a user identity as admin of the wrapped collaboration group.
- *
- * <p>
- *    <em>Only non-admins will be added</em>, i.e. a user identity that already is an admin will be ignored.
- *    Collaboration groups that are <em>inactive/unavailable</em> don't accept any new admins.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> To add an admin to the wrapped group, current user must have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP} on the group.
- * </p>Gets the members of the wrapped collaboration group.
- *
- * <p>
- *    <em>Note!</em> Admins are also considered as members.
- * </p>Checks if a user identity is member of the wrapped collaboration group.Adds a user identity as member of the wrapped collaboration group.
- *
- * <p>
- *    <em>Only non-members will be added</em>, i.e. a user identity that already is a member will be ignored.
- *    Collaboration groups that are <em>inactive</em> doesn't accept any new members.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> To add a member to the wrapped group, current user must have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP} on the group -
- *    or current user must match the given user identity (i.e. "is yourself") and have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on the wrapped group.
- * </p>Removes a member from the wrapped collaboration group.
- *
- * <p>
- *    <em>Only members can be removed</em>, i.e. a user identity that is a non-member will be ignored. Note that an <em>admin</em>
- *    is also a <em>member</em> so removing a member might in fact also remove an <em>admin</em>, but <em>last admin</em> will never be removed.
- *    Members can not be removed from collaboration groups that are <em>inactive</em>.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> To remove group membership for a user identity, current user
- *    must match the user identity (i.e. "is yourself") - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on the wrapped group.
- * </p>Gets the followers/eavesdroppers of the wrapped collaboration group.Checks if a user identity is a follower/eavesdropper of the wrapped collaboration group.Alters the name of the wrapped collaboration group.
- *
- * <p>
- *    <strong>Permission note!</strong> Current user must have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    on the wrapped collaboration group.
- * </p>
- *
- * <p>
- *    <em>Name note!</em> Each group name must be (case-insensitively) unique in a given structure (i.e. collaboration group folder).
- *    This method will remove leading and trailing whitespace from <code>aGroupName</code> and use the remaining characters
- *    as new name. The wrapped group will <em>not</em> be renamed if <code>aGroupName</code> is <code>null</code>, whitespace only or if
- *    the remaining characters already exist as group name.
- * </p>
- *
- * <p>
- *    <em>Tip!</em> Use {@link CollaborationGroupFolderUtil#containsCollaborationGroup(javax.jcr.Node, String)}
- *    to check if a named collaboration group already exists in the collaboration group folder of the group.
- * </p>Gets the collaboration group type of the wrapped collaboration group.Changes the collaboration group type of the wrapped collaboration group.
- *
- * <p>
- *    The group type can not be changed for collaboration groups that are <em>inactive</em>.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> Current user must have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    on the wrapped collaboration group in order to change group type. In order to change group type to
- *    {@link CollaborationGroupType#CLOSED},
- *    current user must also have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_CLOSED_COLLABORATION_GROUP}
- *    on the wrapped collaboration group.
- * </p>Gets the collaboration group state of the wrapped collaboration group.Changes the collaboration group state of the wrapped collaboration group.
- *
- * <p>
- *    <strong>Permission note!</strong> Current user must have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    on the wrapped collaboration group in order to change group state.
- * </p>Gets the group description of the wrapped collaboration group.Sets the group description of the wrapped collaboration group.
- *
- * <p>
- *    <strong>Permission note!</strong> Current user must have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    on the wrapped collaboration group in order to change group description.
- * </p>Gets the profile images folder of the wrapped collaboration group.Gets the profile image of the wrapped collaboration group.
- *
- * <p>
- *    <em>Note!</em> This method returns the 'raw' profile image (i.e. a Node of type <code>sv:image</code>)
- *    that the group has uploaded. For buddy icons, see {@link senselogic.sitevision.api.render.BuddyIconRenderer}.
- * </p>Sets the profile image of the wrapped collaboration group.
- *
- * <p>
- *    This method <em>sets</em> the active profile image, i.e. determines which profile image that should be used.
- *    To <em>create a new</em> profile image (i.e. new binary data), you would typically use
- *    a method in {@link senselogic.sitevision.api.webresource.ImageUtil} first.
- * </p>
- *
- * <p>
- *    <strong>Model note!</strong> A profile image must be a Node of type <code>sv:image</code>
- *    and a child of the <em>profile images folder</em> of the wrapped collaboration group.
- *    The profile images folder is available via {@link #getProfileImagesFolder()}.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> Current user must have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    on the wrapped collaboration group in order to set the profile image.
- * </p>Alters the render Locale used by the wrapped collaboration group.
- *
- * <p>
- *    <strong>Permission note!</strong> Current user must have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    on the wrapped collaboration group.
- * </p>
- *
- * <p>
- *    <em>
- *       Note! This method sets the Locale on the <code>sv:collaborationGroupPage</code> where the wrapped collaboration group resides.
- *       Mutation of Locale will fail if the collaboration group page is locked.
- *    </em>
- * </p>Gets the wrapped collaboration group.
- *
- * <p>
- *    <em>Note! This method is equivalent with {@link #unwrap()} if this wrapper is created with a <code>sv:collaborationGroup</code> Node.</em>
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
@@ -145,7 +23,7 @@ interface CollaborationGroupWrapper {
    * Gets the admins of the wrapped collaboration group.
    * @return the admins of the wrapped collaboration group. Never null.
    */
-  getAdmins(): Set<unknown>;
+  getAdmins(): unknown;
 
   /**
    * Checks if a user identity is admin of the wrapped collaboration group.
@@ -180,7 +58,7 @@ interface CollaborationGroupWrapper {
    * </p>
    * @return the members of the wrapped collaboration group. Never null.
    */
-  getMembers(): Set<unknown>;
+  getMembers(): unknown;
 
   /**
    * Checks if a user identity is member of the wrapped collaboration group.
@@ -233,7 +111,7 @@ interface CollaborationGroupWrapper {
    * @return the followers of the wrapped collaboration group. Never null.
    * @since Sitevision 4.1
    */
-  getFollowers(): Set<unknown>;
+  getFollowers(): unknown;
 
   /**
    * Checks if a user identity is a follower/eavesdropper of the wrapped collaboration group.
@@ -274,7 +152,7 @@ interface CollaborationGroupWrapper {
    * @return the collaboration group type
    * @since Sitevision 4.1
    */
-  getGroupType(): CollaborationGroupType;
+  getGroupType(): unknown;
 
   /**
    * Changes the collaboration group type of the wrapped collaboration group.
@@ -294,14 +172,14 @@ interface CollaborationGroupWrapper {
    * @param aCollaborationGroupType the collaboration group type
    * @since Sitevision 4.1
    */
-  setGroupType(aCollaborationGroupType: CollaborationGroupType): void;
+  setGroupType(aCollaborationGroupType: unknown): void;
 
   /**
    * Gets the collaboration group state of the wrapped collaboration group.
    * @return the collaboration group state
    * @since Sitevision 4.1
    */
-  getGroupState(): CollaborationGroupState;
+  getGroupState(): unknown;
 
   /**
    * Changes the collaboration group state of the wrapped collaboration group.
@@ -314,7 +192,7 @@ interface CollaborationGroupWrapper {
    * @param aCollaborationGroupState the collaboration group state
    * @since Sitevision 4.1
    */
-  setGroupState(aCollaborationGroupState: CollaborationGroupState): void;
+  setGroupState(aCollaborationGroupState: unknown): void;
 
   /**
    * Gets the group description of the wrapped collaboration group.

package/hidden/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getAdmins: function getAdmins() {},
+  isAdmin: function isAdmin() {},
+  addAdmin: function addAdmin() {},
+  getMembers: function getMembers() {},
+  isMember: function isMember() {},
+  addMember: function addMember() {},
+  removeMember: function removeMember() {},
+  getFollowers: function getFollowers() {},
+  isFollower: function isFollower() {},
+  renameGroup: function renameGroup() {},
+  getGroupType: function getGroupType() {},
+  setGroupType: function setGroupType() {},
+  getGroupState: function getGroupState() {},
+  setGroupState: function setGroupState() {},
+  getGroupDescription: function getGroupDescription() {},
+  setGroupDescription: function setGroupDescription() {},
+  getProfileImagesFolder: function getProfileImagesFolder() {},
+  getProfileImage: function getProfileImage() {},
+  setProfileImage: function setProfileImage() {},
+  setLocale: function setLocale() {},
+  getCollaborationGroup: function getCollaborationGroup() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/context/PortletContextUtil/index.d.ts

@@ -0,0 +1,112 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * Portlet context utility interface.
+ *
+ * <p>
+ *    Contains methods for retrieving information about present portlet execution context.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getPortletContextUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>The offline version (i.e. the version used when editing in the Sitevision editor) markerThe online version (i.e. the published version that visitors can access) marker
+ * @author Magnus Lövgren
+ * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}
+ * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+ */
+
+interface PortletContextUtil {
+  /**
+   * Gets current page (i.e. the page node for the currently executing portlet).
+   * @return current page <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet or current portlet is not bound to any page)
+   */
+  getCurrentPage(): Node;
+
+  /**
+   * Gets current portlet.
+   * @return current portlet as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet)
+   */
+  getCurrentPortlet(): Node;
+
+  /**
+   * Gets current module element (module element draft or module element).
+   * @return current module element as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a module element)
+   * @since Sitevision 4.2
+   */
+  getCurrentModuleElement(): Node;
+
+  /**
+   * Gets current Locale.
+   * @return current <code>Locale</code>, or default <code>Locale</code> if indeterminable
+   * @see senselogic.sitevision.api.node.NodeResolverUtil#getLocaleResolver()
+   */
+  getCurrentLocale(): unknown;
+
+  /**
+   * Gets current user.
+   * @return current user <code>Node</code>, or <code>null</code> if indeterminable
+   * @since Sitevision 2.6
+   */
+  getCurrentUser(): Node;
+
+  /**
+   * Gets current user identity.
+   * @return current user identity <code>Node</code>, or <code>null</code> if indeterminable
+   * @since Sitevision 3.5
+   */
+  getCurrentUserIdentity(): Node;
+
+  /**
+   * Gets current decorated node (applicable during render of a sv:decorationTemplate).
+   *
+   * <p>
+   *    This method returns the "decorated" node (typically a sv:portlet or sv:layout) during render of a sv:decorationTemplate.
+   *    In other words - it returns the node that is decorated with the template-based decoration that is now rendering.
+   * </p>
+   * @return the decorated node or null if indeterminable (i.e. the caller is not a part of a decoration template that is being rendered right now)
+   * @since Sitevision 5.1
+   */
+  getCurrentDecoratedNode(): Node;
+
+  /**
+   * Gets current version.
+   * @return {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}, or {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+   * @since Sitevision 2.6
+   * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#getCurrentVersion()}
+   */
+  getCurrentVersion(): number;
+
+  /**
+   * Gets a unique namespace for the specific portlet that is rendering.
+   *
+   * <p>
+   *    The namespace is based on the prefix (aPrefix) and the current portlet's id.
+   *    If you have two portlets of same type on the same page, the namespaces will differ. This can for instance be very useful when you
+   *    connect a &lt;label&gt; with an &lt;input&gt;. Example in Velocity:
+   * </p>
+   * <pre><code>
+   *   #set ($portletContextUtil = $sitevisionUtils.portletContextUtil)
+   *   ...
+   *   #set ($ns = $portletContextUtil.getPortletNamespace('name'))
+   *   &lt;label for="$ns"&gt;Name: &lt;/label&gt;&lt;input id="$ns" name="name" type="text" /&gt;</code></pre>
+   * The namespace generated in the above example (i.e. <code>$ns</code>) could be something like: <code>name12_2b9561c511855e0ab91800015</code>
+   * @param aPrefix the prefix for the namespace (ensure it only contains chars that are valid in an id value if you use it as such)
+   * @return a unique prefixed namespace for current portlet, or aPrefix if indeterminable
+   */
+  getPortletNamespace(aPrefix: java.lang.String): string;
+
+  /**
+   * Gets a unique nonce for this request.
+   *
+   * <p>
+   *    The nonce should be used for all client-side inline javascript (e.g. <code>&lt;script nonce="..."&gt; ... &lt;script&gt;</code>).
+   *    If not specified, the script might be blocked and ignored by the client/browser due to the content security policy settings of the page
+   *    (i.e. typically when the CSP has no "unsafe-inline" specified).
+   * </p>
+   * @return A unique identifier for this request.
+   * @since Sitevision 2022.08.1
+   */
+  getNonce(): string;
+}

package/hidden/senselogic/sitevision/api/cookie/SiteCookieUtil/index.d.ts

@@ -0,0 +1,166 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * Site cookie utility interface.
+ *
+ * <p>
+ *    Contains methods for retrieving sv:siteCookie Nodes of current site and current user's consent status of them.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getSiteCookieUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ * @see senselogic.sitevision.api.resource.ResourceLocatorUtil#getSiteCookieRepository()
+ * @author Karl Eklöf
+ * @since Sitevision 9.1
+ */
+
+interface SiteCookieUtil {
+  /**
+   * Necessary Site cookies (sv:siteCookie) of current site.
+   * @return the necessary site cookies of current site, or empty list if current site has no site cookies
+   */
+  getNecessarySiteCookies(): unknown[];
+
+  /**
+   * Gets the necessary site cookies category title.
+   * @return necessary site cookies category title
+   */
+  getNecessarySiteCookiesTitle(): string;
+
+  /**
+   * Gets the necessary site cookies category description.
+   * @return necessary site cookies category description
+   */
+  getNecessarySiteCookiesDescription(): string;
+
+  /**
+   * Analytics Site cookies (sv:siteCookie) of current site.
+   * @return the analytics site cookies of current site, or empty list if current site has no site cookies
+   */
+  getAnalyticsSiteCookies(): unknown[];
+
+  /**
+   * Gets the analytics site cookies category title.
+   * @return analytics site cookies category title
+   */
+  getAnalyticsSiteCookiesTitle(): string;
+
+  /**
+   * Gets the analytics site cookies category description.
+   * @return analytics site cookies category description
+   */
+  getAnalyticsSiteCookiesDescription(): string;
+
+  /**
+   * Marketing Site cookies (sv:siteCookie) of current site.
+   * @return the marketing site cookies of current site, or empty list if current site has no site cookies
+   */
+  getMarketingSiteCookies(): unknown[];
+
+  /**
+   * Gets the marketing site cookies category title.
+   * @return marketing site cookies category title
+   */
+  getMarketingSiteCookiesTitle(): string;
+
+  /**
+   * Gets the marketing site cookies category description.
+   * @return marketing site cookies category description
+   */
+  getMarketingSiteCookiesDescription(): string;
+
+  /**
+   * Functional Site cookies (sv:siteCookie) of current site.
+   * @return the functional site cookies of current site, or empty list if current site has no site cookies
+   * @since Sitevision 9.1.1
+   */
+  getFunctionalSiteCookies(): unknown[];
+
+  /**
+   * Gets the functional site cookies category title.
+   * @return functional site cookies category title
+   * @since Sitevision 9.1.1
+   */
+  getFunctionalSiteCookiesTitle(): string;
+
+  /**
+   * Gets the functional site cookies category description.
+   * @return functional site cookies category description
+   * @since Sitevision 9.1.1
+   */
+  getFunctionalSiteCookiesDescription(): string;
+
+  /**
+   * Custom Site cookies (sv:siteCookie) of current site.
+   * @return the custom site cookies of current site, or empty list if current site has no site cookies
+   */
+  getCustomSiteCookies(): unknown[];
+
+  /**
+   * Gets the custom site cookies category title.
+   * @return custom site cookies category title
+   */
+  getCustomSiteCookiesTitle(): string;
+
+  /**
+   * Gets the custom site cookies category description.
+   * @return custom site cookies category description
+   */
+  getCustomSiteCookiesDescription(): string;
+
+  /**
+   * Convenience method that resolves a sv:siteCookie Node from a given cookie identifier.
+   * @param aCookieIdentifier the site cookie identifier
+   * @return the sv:siteCookie Node with the "cookieIdentifier" property that matches aCookieIdentifier. Returns null if aCookieIdentifier is null, blank or indeterminable
+   */
+  resolveSiteCookieByIdentifier(aCookieIdentifier: java.lang.String): Node;
+
+  /**
+   * Checks whether or not current user explicitly has accepted a specific site cookie.
+   * @param aSiteCookie the sv:siteCookie
+   * @return true if current user has accepted aSiteCookie, false otherwise
+   */
+  checkUserConsent(aSiteCookie: Node): boolean;
+
+  /**
+   * Whether or not current user has explicitly accepted/rejected all "user selectable" site cookies.
+   * @return true if there are site cookies that current user hasn't yet accepted/rejected, false otherwise
+   * @see #hasUserConsentCookie()
+   */
+  hasPendingUserConsents(): boolean;
+
+  /**
+   * Whether or not current user has a consent cookie.
+   * @return true if current user has a consent cookie set, false otherwise
+   * @see #hasPendingUserConsents()
+   */
+  hasUserConsentCookie(): boolean;
+
+  /**
+   * The name of the cookie that contains data about site cookie consents.
+   * @return the name of the cookie that contains data about site cookie consents
+   */
+  getUserConsentCookieName(): string;
+
+  /**
+   * Generates a consent string that can be saved as cookie value for the cookie named {@link #getUserConsentCookieName()}.
+   *
+   * <p>
+   *    <em>Note!</em> All "user selectable" sv:siteCookie Nodes that are <em>not</em> present in <code>aAllowCookieIdList</code>
+   *    will be treated as rejected.
+   * </p>
+   * @param aAllowCookieIdList the list of sv:siteCookie accepted by current user
+   * @return a string that represents the accept/reject status for current sv:siteCookie's
+   * @throws IllegalArgumentException if aAllowCookieIdList is null or contains other than sv:siteCookie Nodes
+   */
+  createUserConsentCookieValue(aAllowCookieIdList: java.util.List): string;
+
+  /**
+   * Gets all sv:siteCookie nodes that current user has accepted.
+   * @return the list of sv:siteCookie Nodes current user has accepted. Returns empty list if site has no site cookies or if current user hasn't accepted any sv:siteCookie
+   */
+  getUserConsents(): unknown[];
+}

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

@@ -0,0 +1,153 @@
+/**
+ * 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;
+}