@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/OutputUtilConstants/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.render.OutputUtil}.
+ *
+ * <p>
+ *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.render.OutputUtil}
+ *    constants in Velocity, e.g: <code>$outputUtil.CONTENT_TYPE_TEXT_HTML</code>
+ * </p>Get accessor for {@link senselogic.sitevision.api.render.OutputUtil#CONTENT_TYPE_TEXT_PLAIN}.Get accessor for {@link senselogic.sitevision.api.render.OutputUtil#CONTENT_TYPE_TEXT_HTML}.Get accessor for {@link senselogic.sitevision.api.render.OutputUtil#CONTENT_TYPE_TEXT_XML}.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.2
+ */
+interface VelocityAccess_OutputUtilConstants {
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.render.OutputUtil#CONTENT_TYPE_TEXT_PLAIN}.
+   * @return {@link senselogic.sitevision.api.render.OutputUtil#CONTENT_TYPE_TEXT_PLAIN}
+   */
+  getCONTENT_TYPE_TEXT_PLAIN(): number;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.render.OutputUtil#CONTENT_TYPE_TEXT_HTML}.
+   * @return {@link senselogic.sitevision.api.render.OutputUtil#CONTENT_TYPE_TEXT_HTML}
+   */
+  getCONTENT_TYPE_TEXT_HTML(): number;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.render.OutputUtil#CONTENT_TYPE_TEXT_XML}.
+   * @return {@link senselogic.sitevision.api.render.OutputUtil#CONTENT_TYPE_TEXT_XML}
+   */
+  getCONTENT_TYPE_TEXT_XML(): number;
+}
+
+export default VelocityAccess_OutputUtilConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PageUtilConstants/index.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.webresource.PageUtil}.
+ *
+ * <p>
+ *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.webresource.PageUtil}
+ *    constants in Velocity, e.g: <code>$pageUtil.PROPERTY_LAST_MODIFIED_DATE</code>
+ * </p>Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_VISIBLE_IN_MENUS}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_SHORTID}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LOCALE}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_ROBOTS_INDEX}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_CREATION_DATE}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_CREATED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_MODIFIED_DATE}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_MODIFIED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_PUBLISHED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_PUBLISH_DATE}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_PUBLISHED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_PUBLISH_DATE}.Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_TITLE}.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.2
+ */
+interface VelocityAccess_PageUtilConstants {
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_VISIBLE_IN_MENUS}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_VISIBLE_IN_MENUS}
+   */
+  getPROPERTY_VISIBLE_IN_MENUS(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_SHORTID}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_SHORTID}
+   */
+  getPROPERTY_SHORTID(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LOCALE}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LOCALE}
+   */
+  getPROPERTY_LOCALE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_ROBOTS_INDEX}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_ROBOTS_INDEX}
+   */
+  getPROPERTY_ROBOTS_INDEX(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_CREATION_DATE}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_CREATION_DATE}
+   */
+  getPROPERTY_CREATION_DATE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_CREATED_BY}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_CREATED_BY}
+   */
+  getPROPERTY_CREATED_BY(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_MODIFIED_DATE}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_MODIFIED_DATE}
+   */
+  getPROPERTY_LAST_MODIFIED_DATE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_MODIFIED_BY}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_MODIFIED_BY}
+   */
+  getPROPERTY_LAST_MODIFIED_BY(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_PUBLISHED_BY}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_PUBLISHED_BY}
+   */
+  getPROPERTY_LAST_PUBLISHED_BY(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_PUBLISH_DATE}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_PUBLISH_DATE}
+   */
+  getPROPERTY_LAST_PUBLISH_DATE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_PUBLISHED_BY}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_PUBLISHED_BY}
+   */
+  getPROPERTY_PUBLISHED_BY(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_PUBLISH_DATE}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_PUBLISH_DATE}
+   */
+  getPROPERTY_PUBLISH_DATE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_TITLE}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_TITLE}
+   */
+  getPROPERTY_TITLE(): string;
+}
+
+export default VelocityAccess_PageUtilConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PortletContextUtilConstants/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.context.PortletContextUtil}.
+ *
+ * <p>
+ *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.context.PortletContextUtil}
+ *    constants in Velocity, e.g: <code>$portletContextUtil.ONLINE_VERSION</code>
+ * </p>Get accessor for {@link senselogic.sitevision.api.context.PortletContextUtil#ONLINE_VERSION}.Get accessor for {@link senselogic.sitevision.api.context.PortletContextUtil#OFFLINE_VERSION}.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.2
+ */
+interface VelocityAccess_PortletContextUtilConstants {
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.context.PortletContextUtil#ONLINE_VERSION}.
+   * @return {@link senselogic.sitevision.api.context.PortletContextUtil#ONLINE_VERSION}
+   * @deprecated
+   */
+  getONLINE_VERSION(): number;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.context.PortletContextUtil#OFFLINE_VERSION}.
+   * @return {@link senselogic.sitevision.api.context.PortletContextUtil#OFFLINE_VERSION}
+   * @deprecated
+   */
+  getOFFLINE_VERSION(): number;
+}
+
+export default VelocityAccess_PortletContextUtilConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PortletUtilConstants/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.resource.PortletUtil}.
+ *
+ * <p>
+ *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.resource.PortletUtil}
+ *    constants in Velocity, e.g: <code>$portletUtil.PORTLET_PREFERENCES_TYPE_USER</code>
+ * </p>Get accessor for {@link senselogic.sitevision.api.resource.PortletUtil#PORTLET_PREFERENCES_TYPE_USER}.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.2
+ */
+interface VelocityAccess_PortletUtilConstants {
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.resource.PortletUtil#PORTLET_PREFERENCES_TYPE_USER}.
+   * @return {@link senselogic.sitevision.api.resource.PortletUtil#PORTLET_PREFERENCES_TYPE_USER}
+   */
+  getPORTLET_PREFERENCES_TYPE_USER(): number;
+}
+
+export default VelocityAccess_PortletUtilConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/QueryStringUtilConstants/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.search.query.QueryStringUtil}.
+ *
+ * <p>
+ *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.search.query.QueryStringUtil}
+ *    constants in Velocity, e.g: <code>$queryStringUtil.MATCH_ALL_QUERY</code>
+ * </p>Get accessor for {@link senselogic.sitevision.api.search.query.QueryStringUtil#MATCH_ALL_QUERY}.
+ * @author Magnus Lövgren
+ * @since Sitevision 8.2
+ */
+interface VelocityAccess_QueryStringUtilConstants {
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.search.query.QueryStringUtil#MATCH_ALL_QUERY}.
+   * @return {@link senselogic.sitevision.api.search.query.QueryStringUtil#MATCH_ALL_QUERY}
+   */
+  getMATCH_ALL_QUERY(): string;
+}
+
+export default VelocityAccess_QueryStringUtilConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/SearchHitConstants/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.search.SearchHit}.
+ *
+ * <p>
+ *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.search.SearchHit}
+ *    constants in Velocity, e.g: <code>$searchHit.TYPE_INTERNAL</code>
+ * </p>Get accessor for {@link senselogic.sitevision.api.search.SearchHit#TYPE_INTERNAL}.Get accessor for {@link senselogic.sitevision.api.search.SearchHit#TYPE_EXTERNAL}.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.2
+ */
+interface VelocityAccess_SearchHitConstants {
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.search.SearchHit#TYPE_INTERNAL}.
+   * @return {@link senselogic.sitevision.api.search.SearchHit#TYPE_INTERNAL}
+   */
+  getTYPE_INTERNAL(): number;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.search.SearchHit#TYPE_EXTERNAL}.
+   * @return {@link senselogic.sitevision.api.search.SearchHit#TYPE_EXTERNAL}
+   */
+  getTYPE_EXTERNAL(): number;
+}
+
+export default VelocityAccess_SearchHitConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/SearchResultConstants/index.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.search.SearchResult}.
+ *
+ * <p>
+ *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.search.SearchResult}
+ *    constants in Velocity, e.g: <code>$searchResult.STATUS_OK</code>
+ * </p>Get accessor for {@link senselogic.sitevision.api.search.SearchResult#STATUS_OK}.Get accessor for {@link senselogic.sitevision.api.search.SearchResult#STATUS_INDEX_NOT_AVAILABLE}.Get accessor for {@link senselogic.sitevision.api.search.SearchResult#STATUS_PARSE_ERROR}.Get accessor for {@link senselogic.sitevision.api.search.SearchResult#STATUS_UNEXPECTED_ERROR}.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.2
+ */
+interface VelocityAccess_SearchResultConstants {
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.search.SearchResult#STATUS_OK}.
+   * @return {@link senselogic.sitevision.api.search.SearchResult#STATUS_OK}
+   */
+  getSTATUS_OK(): number;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.search.SearchResult#STATUS_INDEX_NOT_AVAILABLE}.
+   * @return {@link senselogic.sitevision.api.search.SearchResult#STATUS_INDEX_NOT_AVAILABLE}
+   */
+  getSTATUS_INDEX_NOT_AVAILABLE(): number;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.search.SearchResult#STATUS_PARSE_ERROR}.
+   * @return {@link senselogic.sitevision.api.search.SearchResult#STATUS_PARSE_ERROR}
+   */
+  getSTATUS_PARSE_ERROR(): number;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.search.SearchResult#STATUS_UNEXPECTED_ERROR}.
+   * @return {@link senselogic.sitevision.api.search.SearchResult#STATUS_UNEXPECTED_ERROR}
+   */
+  getSTATUS_UNEXPECTED_ERROR(): number;
+}
+
+export default VelocityAccess_SearchResultConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/VersionUtilConstants/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.versioning.VersionUtil}.
+ *
+ * <p>
+ *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.versioning.VersionUtil}
+ *    constants in Velocity, e.g: <code>$versionUtil.ONLINE_VERSION</code>
+ * </p>Get accessor for {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}.Get accessor for {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.2
+ */
+interface VelocityAccess_VersionUtilConstants {
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}.
+   * @return {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+   */
+  getONLINE_VERSION(): number;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}.
+   * @return {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}
+   */
+  getOFFLINE_VERSION(): number;
+}
+
+export default VelocityAccess_VersionUtilConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Enclosing interface that enables method access in Velocity to common field constants of this API.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.2
+ */
+interface VelocityAccess {}
+
+export default VelocityAccess;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityContext/index.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Name/Object mappings that can be used when rendering a Velocity template.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via a <code>getVelocityContext</code>
+ *    method in {@link senselogic.sitevision.api.render.velocity.VelocityRenderer}.
+ * </p>Adds a Name/Object mapping to the context.
+ * Null key mappings will be ignored.Returns the mapped object for a specified name.Checks whether a name has a mapping or not.Returns all names.Removes a Name/Object mapping.
+ * @author Magnus Lövgren
+ * @see VelocityRenderer
+ * @since Sitevision 3.0
+ */
+interface VelocityContext {
+  /**
+   * Adds a Name/Object mapping to the context.
+   * Null key mappings will be ignored.
+   * @param aKey a name, not <code>null</code>
+   * @param anObject an object
+   */
+  put(aKey: string, anObject: unknown): void;
+
+  /**
+   * Returns the mapped object for a specified name.
+   * @param aKey the name.
+   * @return the Object mapped for aKey, or <code>null</code> if no mapping for aKey exist
+   */
+  get(aKey: string): unknown;
+
+  /**
+   * Checks whether a name has a mapping or not.
+   * @param aKey the name
+   * @return <code>true</code> if an Object is mapped for aKey, <code>false</code> otherwise
+   */
+  containsKey(aKey: string): boolean;
+
+  /**
+   * Returns all names.
+   * @return all names.
+   */
+  getKeys(): string;
+
+  /**
+   * Removes a Name/Object mapping.
+   * @param aKey the name.
+   * @return the Object mapped to aKey, or <code>null</code> if no mapping for aKey exist
+   */
+  remove(aKey: string): unknown;
+}
+
+export default VelocityContext;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Utility class for parsing of Velocity Code.
+ *
+ * <p>
+ *    An instance of this interface can never be directly created and all instances are heavily bound to the Velocity
+ *    context they were created for.
+ * </p>Renders a template that is parsed/evaluated by Velocity.
+ *
+ * <p>
+ *    <strong>Note!</strong> This method is intended for usage from within Velocity only
+ *    (e.g. <code>$aVelocityEvaluatorInstance.evaluate($aTemplateString)</code>),
+ *    see {@link VelocityRenderer} for an example.
+ * </p>
+ *
+ * <p>
+ *    <em>
+ *       <strong>Tip when evaluating velocity files in a custom portlet!</strong>
+ *       The path to your portlet's velocity file(-s) are class loader dependant and therefore likely to have
+ *       it's root from the "classes" folder of your war. An example, your portlet war looks like this:
+ *    </em>
+ * </p>
+ * <pre><em>
+ *    [META-INF]
+ *      |- context.xml
+ *    [WEB-INF]
+ *      |- portlet.xml
+ *      |- web.xml
+ *      |- [classes]
+ *      |      |- [com]
+ *      |           |- [mycompany]
+ *      |                  |- [myportlet]
+ *      |                        |- MyPortlet.class
+ *      |- [resources]
+ *             |- myvelocityfile.vm
+ * </em></pre>
+ * <p>
+ *    <em>
+ *       If you want to use a VelocityEvaluator to evaluate the <code>myvelocityfile.vm</code> in the <code>MyPortlet.class</code>,
+ *       your velocity file path would likely be <code>"../resources/myvelocityfile.vm"</code>.
+ *    </em>
+ * </p>
+ * @author Magnus Lövgren
+ * @see VelocityRenderer
+ * @since Sitevision 2.7_06
+ * @since Sitevision 3.0
+ */
+interface VelocityEvaluator {
+  /**
+   * Renders a template that is parsed/evaluated by Velocity.
+   *
+   * <p>
+   *    <strong>Note!</strong> This method is intended for usage from within Velocity only
+   *    (e.g. <code>$aVelocityEvaluatorInstance.evaluate($aTemplateString)</code>),
+   *    see {@link VelocityRenderer} for an example.
+   * </p>
+   *
+   * <p>
+   *    <em>
+   *       <strong>Tip when evaluating velocity files in a custom portlet!</strong>
+   *       The path to your portlet's velocity file(-s) are class loader dependant and therefore likely to have
+   *       it's root from the "classes" folder of your war. An example, your portlet war looks like this:
+   *    </em>
+   * </p>
+   * <pre><em>
+   *    [META-INF]
+   *      |- context.xml
+   *    [WEB-INF]
+   *      |- portlet.xml
+   *      |- web.xml
+   *      |- [classes]
+   *      |      |- [com]
+   *      |           |- [mycompany]
+   *      |                  |- [myportlet]
+   *      |                        |- MyPortlet.class
+   *      |- [resources]
+   *             |- myvelocityfile.vm
+   * </em></pre>
+   * <p>
+   *    <em>
+   *       If you want to use a VelocityEvaluator to evaluate the <code>myvelocityfile.vm</code> in the <code>MyPortlet.class</code>,
+   *       your velocity file path would likely be <code>"../resources/myvelocityfile.vm"</code>.
+   *    </em>
+   * </p>
+   * @param aTemplate a String containing the Velocity code to be parsed or a path to a velocity template file (suffix must be ".vm" and path must not contain any space character)
+   */
+  evaluate(aTemplate: string): void;
+}
+
+export default VelocityEvaluator;

package/hidden/senselogic/sitevision/api/script/RequesterChainable/index.d.ts

@@ -0,0 +1,119 @@
+/**
+ * The chainable result of a {@link Requester} invocation.Invoked when a {@link Requester} was successfully executed.
+ *
+ * <p>
+ *    The callback is invoked with three optional arguments:
+ * </p>
+ * <ol>
+ *    <li>
+ *       First argument is the <em>result</em> - typically a JSON object.
+ *    </li>
+ *    <li>
+ *       Second argument [@since Sitevision 4.2.3] is the <em>statusCode</em> - the http response status code.
+ *    </li>
+ *    <li>
+ *       Third argument [@since Sitevision 4.5.1] is the <em>headers</em> - the http response headers.
+ *    </li>
+ * </ol>Invoked when a {@link Requester} was unsuccessfully executed.
+ *
+ * <p>
+ *    The callback is invoked with two optional arguments:
+ * </p>
+ * <ol>
+ *    <li>
+ *       First argument is the <em>message</em> - a string that describes the fail reason.
+ *    </li>
+ *    <li>
+ *       Second argument [@since Sitevision 4.2.2] is the <em>status</em> - an object with four properties:
+ *       <ul>
+ *          <li>
+ *             <em>statusCode</em> - the http response status code.<br>
+ *             The value will typically be an official/RFC-standardized code
+ *             (such as 400, 401, 404, 500 etc), but it can also be an unofficial/non-standardized one.
+ *             A connection timeout will have value 1000 and the value will be 1001 if the connection pool is full/exhausted.
+ *             An unknown/unspecified error will have value -1, such as unknown host, illegal url or network connection errors.
+ *          </li>
+ *          <li>
+ *             <em>statusMessage</em> - the http response status code description.
+ *          </li>
+ *          <li>
+ *             <em>body</em> [@since Sitevision 4.2.3] - the potential JSON body of the response.
+ *             <em>(Note! Will only be available for responses that specifies application/json in the Content-Type header)</em>
+ *          </li>
+ *          <li>
+ *             <em>headers</em> [@since Sitevision 4.5.1] - the potential response headers.
+ *             <em>(Note! Will only be available for valid error responses, not for request errors, JSON parse errors or such)</em>
+ *          </li>
+ *       </ul>
+ *    </li>
+ * </ol>
+ * @param <O> script object
+ * @param <F> script function
+ * @author Magnus Lövgren
+ * @since Sitevision 4.2
+ * @see Requester
+ */
+interface RequesterChainable {
+  /**
+   * Invoked when a {@link Requester} was successfully executed.
+   *
+   * <p>
+   *    The callback is invoked with three optional arguments:
+   * </p>
+   * <ol>
+   *    <li>
+   *       First argument is the <em>result</em> - typically a JSON object.
+   *    </li>
+   *    <li>
+   *       Second argument [@since Sitevision 4.2.3] is the <em>statusCode</em> - the http response status code.
+   *    </li>
+   *    <li>
+   *       Third argument [@since Sitevision 4.5.1] is the <em>headers</em> - the http response headers.
+   *    </li>
+   * </ol>
+   * @param aCallback a callback function that handles the result
+   * @return a chainable requester
+   */
+  done(aCallback: unknown): RequesterChainable;
+
+  /**
+   * Invoked when a {@link Requester} was unsuccessfully executed.
+   *
+   * <p>
+   *    The callback is invoked with two optional arguments:
+   * </p>
+   * <ol>
+   *    <li>
+   *       First argument is the <em>message</em> - a string that describes the fail reason.
+   *    </li>
+   *    <li>
+   *       Second argument [@since Sitevision 4.2.2] is the <em>status</em> - an object with four properties:
+   *       <ul>
+   *          <li>
+   *             <em>statusCode</em> - the http response status code.<br>
+   *             The value will typically be an official/RFC-standardized code
+   *             (such as 400, 401, 404, 500 etc), but it can also be an unofficial/non-standardized one.
+   *             A connection timeout will have value 1000 and the value will be 1001 if the connection pool is full/exhausted.
+   *             An unknown/unspecified error will have value -1, such as unknown host, illegal url or network connection errors.
+   *          </li>
+   *          <li>
+   *             <em>statusMessage</em> - the http response status code description.
+   *          </li>
+   *          <li>
+   *             <em>body</em> [@since Sitevision 4.2.3] - the potential JSON body of the response.
+   *             <em>(Note! Will only be available for responses that specifies application/json in the Content-Type header)</em>
+   *          </li>
+   *          <li>
+   *             <em>headers</em> [@since Sitevision 4.5.1] - the potential response headers.
+   *             <em>(Note! Will only be available for valid error responses, not for request errors, JSON parse errors or such)</em>
+   *          </li>
+   *       </ul>
+   *    </li>
+   * </ol>
+   * @param aCallback a callback function that handles fail state
+   * @return a chainable requester
+   */
+  fail(aCallback: unknown): RequesterChainable;
+}
+
+export default RequesterChainable;