@sitevision/api 2023.2.1 → 2023.2.2-beta.1

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

@@ -1,10 +1,12 @@
+import type { String } from "../../../../../../java/lang/String";
+
 /**
  * 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>
+ *  <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>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */

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

@@ -1,10 +1,10 @@
 /**
  * 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>
+ *  <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>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */

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

@@ -1,10 +1,10 @@
 /**
  * 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>
+ *  <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>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */

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

@@ -1,10 +1,12 @@
+import type { String } from "../../../../../../java/lang/String";
+
 /**
  * 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>
+ *  <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>
  * @author Magnus Lövgren
  * @since Sitevision 8.2
  */

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

@@ -1,10 +1,10 @@
 /**
  * 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>
+ *  <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>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */

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

@@ -1,10 +1,10 @@
 /**
  * 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>
+ *  <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>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */

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

@@ -1,10 +1,10 @@
 /**
  * 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>
+ *  <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>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */

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

@@ -1,10 +1,13 @@
+import type { String } from "../../../../../../java/lang/String";
+import type { Object } from "../../../../../../java/lang/Object";
+
 /**
  * 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>
+ *  <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>
  * @author Magnus Lövgren
  * @see VelocityRenderer
  * @since Sitevision 3.0
@@ -12,25 +15,25 @@
 export type VelocityContext = {
   /**
    * Adds a Name/Object mapping to the context.
-   * Null key mappings will be ignored.
+   *  Null key mappings will be ignored.
    * @param aKey a name, not <code>null</code>
    * @param anObject an object
    */
-  put(aKey: string, anObject: unknown): void;
+  put(aKey: String | 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;
+  get(aKey: String | 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;
+  containsKey(aKey: String | string): boolean;
 
   /**
    * Returns all names.
@@ -43,5 +46,5 @@ export type VelocityContext = {
    * @param aKey the name.
    * @return the Object mapped to aKey, or <code>null</code> if no mapping for aKey exist
    */
-  remove(aKey: string): unknown;
+  remove(aKey: String | string): unknown;
 };

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

@@ -1,10 +1,12 @@
+import type { String } from "../../../../../../java/lang/String";
+
 /**
  * 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>
+ *  <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>
  * @author Magnus Lövgren
  * @see VelocityRenderer
  * @since Sitevision 2.7_06
@@ -14,40 +16,40 @@ export type 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>
+   *     <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)
+   *  <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&#xA; (suffix must be ".vm" and path must not contain any space character)
    */
-  evaluate(aTemplate: string): void;
+  evaluate(aTemplate: String | string): void;
 };

package/types/senselogic/sitevision/api/render/velocity/VelocityException/index.d.ts

@@ -0,0 +1,9 @@
+import type { RuntimeException } from "../../../../../../java/lang/RuntimeException";
+
+/**
+ * A runtime exception that can occur when rendering a Velocity template.
+ * @author Magnus Lövgren
+ * @see VelocityRenderer#render(VelocityContext, String)
+ * @since Sitevision 3.0
+ */
+export type VelocityException = RuntimeException & {};

package/types/senselogic/sitevision/api/render/velocity/VelocityException/index.js

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

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

@@ -1,4 +1,4 @@
-import { Requester } from "../../../../../../server/Requester";
+import type { Requester } from "../../../../../../server/Requester";
 
 /**
  * The chainable result of a {@link Requester} invocation.
@@ -12,20 +12,20 @@ export type RequesterChainable = Requester & {
   /**
    * 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>
+   *  <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
    */
@@ -34,37 +34,37 @@ export type RequesterChainable = Requester & {
   /**
    * 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>
+   *  <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
    */