@sitevision/api 2025.4.1 → 2025.5.1

package/common/events/index.d.ts

@@ -1,3 +1,332 @@
+import type { Node } from '../../types/javax/jcr/Node';
+
+/** Emitted when something (typically a page) is published. */
+export type PublishingPublishOptions = {
+  /** The full name of the event */
+  event: 'sv:publishing:publish';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the node that was published */
+  node: string;
+  /** If the publishing comment feature is enabled and a comment has been provided */
+  publishingComment?: string;
+};
+
+/** Emitted when something (typically a page) is unpublished. */
+export type PublishingUnpublishOptions = {
+  /** The full name of the event */
+  event: 'sv:publishing:unpublish';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the node that was unpublished */
+  node: string;
+};
+
+/** Emitted when a simple user is created. */
+export type SimpleUserCreateOptions = {
+  /** The full name of the event */
+  event: 'sv:simpleuser:create';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the simple user that was created */
+  user: string;
+};
+
+/** Emitted when a simple user is updated. */
+export type SimpleUserUpdateOptions = {
+  /** The full name of the event */
+  event: 'sv:simpleuser:update';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the simple user that was updated */
+  user: string;
+};
+
+/** Emitted when the http session for a simple user is destroyed (e.g. session timed out). */
+export type SimpleUserSessionDestroyOptions = {
+  /** The full name of the event */
+  event: 'sv:simpleuser:session:destroy';
+  /** No user is emitting the event */
+  emitter: 'anonymous',
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the simple user whose session was destroyed */
+  user: string;
+};
+
+/** Emitted when something (typically a page) is moved. */
+export type StructureMoveOptions = {
+  /** The full name of the event */
+  event: 'sv:structure:move';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the node that was moved */
+  node: string;
+  /** The JCR identifier of the old parent node */
+  from: string;
+  /** The JCR identifier of the new parent node */
+  to: string;
+};
+
+/** Emitted when something (typically a page/article/file/image) is added to the trashcan. */
+export type TrashcanAddOptions = {
+  /** The full name of the event */
+  event: 'sv:trashcan:add';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the node that was trashed */
+  node: string;
+};
+
+/** Emitted when something (typically a page/article/file/image) is restored from the trashcan. */
+export type TrashcanRestoreOptions = {
+  /** The full name of the event */
+  event: 'sv:trashcan:restore';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the node that was restored */
+  node: string;
+};
+
+/** Emitted when a file or an image is added to a repository or folder. */
+export type BinaryCreateOptions = {
+  /** The full name of the event */
+  event: 'sv:binary:create';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the file that has been created */
+  node: string;
+};
+
+/** Emitted when the content for a file or an image has been updated. */
+export type BinaryUpdateContentOptions = {
+  /** The full name of the event */
+  event: 'sv:binary:update:content';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the file that was updated */
+  node: string;
+};
+
+/** Emitted when metadata for a file or an image has been updated. */
+export type BinaryUpdateMetadataOptions = {
+  /** The full name of the event */
+  event: 'sv:binary:update:metadata';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the file that has updated metadata */
+  node: string;
+};
+
+/** Emitted when the name of a file or an image has been changed. */
+export type BinaryUpdateNameOptions = {
+  /** The full name of the event */
+  event: 'sv:binary:update:name';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the file that has been renamed */
+  node: string;
+};
+
+/** Emitted when tags for a file or an image has been changed. */
+export type BinaryUpdateTagsOptions = {
+  /** The full name of the event */
+  event: 'sv:binary:update:tags';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the file that was changed */
+  node: string;
+};
+
+/** Emitted when a new version of a file has been created. */
+export type BinaryUpdateVersionCreateOptions = {
+  /** The full name of the event */
+  event: 'sv:binary:update:version:create';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the file that has a new version */
+  node: string;
+};
+
+/** Emitted when a version of a file has been deleted. */
+export type BinaryUpdateVersionDeleteOptions = {
+  /** The full name of the event */
+  event: 'sv:binary:update:version:delete';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the file that has a deleted version */
+  node: string;
+};
+
+/** Emitted when a version of a file has been selected. */
+export type BinaryUpdateVersionSelectOptions = {
+  /** The full name of the event */
+  event: 'sv:binary:update:version:select';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the file that has a new version selected */
+  node: string;
+};
+
+/** Emitted when a folder whose metadata is updated. */
+export type FolderUpdateMetadataOptions = {
+  /** The full name of the event */
+  event: 'sv:folder:update:metadata';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the folder that has been updated */
+  node: string;
+};
+
+/** Form field answer structure */
+export type FormAnswer = {
+  /** Unique identifier for the form field */
+  id: string;
+  /** The question or prompt shown to the user */
+  question: string;
+  /** User's answer as a string or a [sv:temporaryFile](https://developer.sitevision.se/docs/public-api/node-types/node-types/2019-02-20-svtemporaryfile) for file uploads */
+  value: string | Node;
+};
+
+/** Emitted when Sitevision's email/question-form module is posted. */
+export type FormPostOptions = {
+  /** The full name of the event */
+  event: 'sv:form:post';
+  /** The JCR identifier of the emitting user */
+  emitter: string;
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+  /** The JCR identifier of the page the form was posted */
+  node: string;
+  /** Array of form field answers */
+  answers: FormAnswer[];
+};
+
+/** Emitted every 5 minutes. */
+export type Every5MinutesOptions = {
+  /** The full name of the event */
+  event: 'sv:every-5-minutes';
+  /** No user is emitting the event */
+  emitter: 'anonymous';
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+};
+
+/** Emitted every 15 minutes. */
+export type Every15MinutesOptions = {
+  /** The full name of the event */
+  event: 'sv:every-15-minutes';
+  /** No user is emitting the event */
+  emitter: 'anonymous';
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+};
+
+/** Emitted every 30 minutes. */
+export type Every30MinutesOptions = {
+  /** The full name of the event */
+  event: 'sv:every-30-minutes';
+  /** No user is emitting the event */
+  emitter: 'anonymous';
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+};
+
+/** Emitted every hour. */
+export type EveryHourOptions = {
+  /** The full name of the event */
+  event: 'sv:every-hour';
+  /** No user is emitting the event */
+  emitter: 'anonymous';
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+};
+
+/** Emitted every day. */
+export type EveryDayOptions = {
+  /** The full name of the event */
+  event: 'sv:every-day';
+  /** No user is emitting the event */
+  emitter: 'anonymous';
+  /** The timestamp when the event was emitted */
+  timestamp: number;
+};
+
+// Union types for grouped events
+/** All publishing-related event options */
+export type PublishingOptions = PublishingPublishOptions | PublishingUnpublishOptions;
+
+/** All simple user-related event options */
+export type SimpleUserOptions =
+  | SimpleUserCreateOptions
+  | SimpleUserUpdateOptions
+  | SimpleUserSessionDestroyOptions;
+
+/** All binary-related event options */
+export type BinaryOptions =
+  | BinaryCreateOptions
+  | BinaryUpdateContentOptions
+  | BinaryUpdateMetadataOptions
+  | BinaryUpdateNameOptions
+  | BinaryUpdateTagsOptions
+  | BinaryUpdateVersionCreateOptions
+  | BinaryUpdateVersionDeleteOptions
+  | BinaryUpdateVersionSelectOptions;
+
+/** All timer-related event options */
+export type TimerOptions =
+  | Every5MinutesOptions
+  | Every15MinutesOptions
+  | Every30MinutesOptions
+  | EveryHourOptions
+  | EveryDayOptions;
+
+/** All trashcan-related event options */
+export type TrashcanOptions = TrashcanAddOptions | TrashcanRestoreOptions;
+
+/** All possible system event options */
+export type AllSystemOptions =
+  | PublishingOptions
+  | SimpleUserOptions
+  | BinaryOptions
+  | TimerOptions
+  | TrashcanOptions
+  | StructureMoveOptions
+  | FolderUpdateMetadataOptions
+  | FormPostOptions;
+
 export interface Events {
   /**
    * Listen to a given event
@@ -6,6 +335,34 @@ export interface Events {
    * @param callback The callback to trigger for the given event
    */
   on(eventName: string, callback: (options: unknown) => void): void;
+  on(eventName: 'sv:publishing', callback: (options: PublishingOptions) => void): void;
+  on(eventName: 'sv:publishing:publish', callback: (options: PublishingPublishOptions) => void): void;
+  on(eventName: 'sv:publishing:unpublish', callback: (options: PublishingUnpublishOptions) => void): void;
+  on(eventName: 'sv:simpleuser', callback: (options: SimpleUserOptions) => void): void;
+  on(eventName: 'sv:simpleuser:create', callback: (options: SimpleUserCreateOptions) => void): void;
+  on(eventName: 'sv:simpleuser:update', callback: (options: SimpleUserUpdateOptions) => void): void;
+  on(eventName: 'sv:simpleuser:session:destroy', callback: (options: SimpleUserSessionDestroyOptions) => void): void;
+  on(eventName: 'sv:structure:move', callback: (options: StructureMoveOptions) => void): void;
+  on(eventName: 'sv:trashcan', callback: (options: TrashcanOptions) => void): void;
+  on(eventName: 'sv:trashcan:add', callback: (options: TrashcanAddOptions) => void): void;
+  on(eventName: 'sv:trashcan:restore', callback: (options: TrashcanRestoreOptions) => void): void;
+  on(eventName: 'sv:binary', callback: (options: BinaryOptions) => void): void;
+  on(eventName: 'sv:binary:create', callback: (options: BinaryCreateOptions) => void): void;
+  on(eventName: 'sv:binary:update:content', callback: (options: BinaryUpdateContentOptions) => void): void;
+  on(eventName: 'sv:binary:update:metadata', callback: (options: BinaryUpdateMetadataOptions) => void): void;
+  on(eventName: 'sv:binary:update:name', callback: (options: BinaryUpdateNameOptions) => void): void;
+  on(eventName: 'sv:binary:update:tags', callback: (options: BinaryUpdateTagsOptions) => void): void;
+  on(eventName: 'sv:binary:update:version:create', callback: (options: BinaryUpdateVersionCreateOptions) => void): void;
+  on(eventName: 'sv:binary:update:version:delete', callback: (options: BinaryUpdateVersionDeleteOptions) => void): void;
+  on(eventName: 'sv:binary:update:version:select', callback: (options: BinaryUpdateVersionSelectOptions) => void): void;
+  on(eventName: 'sv:folder:update:metadata', callback: (options: FolderUpdateMetadataOptions) => void): void;
+  on(eventName: 'sv:form:post', callback: (options: FormPostOptions) => void): void;
+  on(eventName: 'sv:every-5-minutes', callback: (options: Every5MinutesOptions) => void): void;
+  on(eventName: 'sv:every-15-minutes', callback: (options: Every15MinutesOptions) => void): void;
+  on(eventName: 'sv:every-30-minutes', callback: (options: Every30MinutesOptions) => void): void;
+  on(eventName: 'sv:every-hour', callback: (options: EveryHourOptions) => void): void;
+  on(eventName: 'sv:every-day', callback: (options: EveryDayOptions) => void): void;
+
   /**
    * Stop listening to a given event
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2025.4.1",
+  "version": "2025.5.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -30,5 +30,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "685a5b71ce767337f6f5d8cf0ff10dadafda91d6"
+  "gitHead": "28570281cd01424c7ed0772fb5a5f004c92712b1"
 }

package/server/Utils/index.d.ts

@@ -405,46 +405,34 @@ export interface Utils {
   getImageScaler(aMaxWidth: number, aMaxHeight: number): ImageScaler;
 
   /**
-   * Creates and returns an instance of an exception-suppressing proxy.
-   *
-   *  <p>
-   *  <strong>Note! </strong>Be aware of <code>null</code>'s. They are never proxied. If you try to proxy <code>null</code>, this method
-   *  will just return <code>null</code>, not a proxy instance. In other words: even though you're trying to use a
-   *  <code>ExceptionSuppressingProxy</code> to suppress exceptions,
-   *  method invocations will of course still throw <code>NullPointerException</code>.
-   *  </p>
-   * @param anObject an object to be proxied by an ExceptionSuppressingProxy
-   * @return anObject proxied by an ExceptionSuppressingProxy, or <code>null</code> if <code>anObject</code> is <code>null</code>.&#xA; If <code>anObject</code> is a <code>ExceptionSuppressingProxy</code>),&#xA; <code>anObject</code> will be returned "as-is" (no new instance will be created).
+   * Deprecated get method for deprecated ExceptionSuppressingProxy.
+   * @param aObject an object to be proxied by an ExceptionSuppressingProxy
+   * @return a deprecated ExceptionSuppressingProxy, or null if aObject is null.
    * @since Sitevision 2.6.1_09
+   * @deprecated ExceptionSuppressingProxy is not supported, this method deprecated and will be removed in a future version of Sitevision
    */
-  getExceptionSuppressingProxy(anObject: unknown): ExceptionSuppressingProxy;
+  getExceptionSuppressingProxy(aObject: unknown): ExceptionSuppressingProxy;
 
   /**
-   * Creates and returns an instance of a collection decorator that exposes an exception-suppressing iterator.
-   *
-   *  <p>
-   *  <strong>Note!</strong> The sole purpose of the <code>ExceptionSuppressingCollection</code> is to provide easy access to a decorated iterator
-   *  ({@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingIterator}).
-   *  You should <em>not</em> create a collection of object proxys (i.e. <code>Collection&lt;ExceptionSuppressingProxy&gt;</code>) yourself.
-   *  You should use <code>ExceptionSuppressingCollection</code>
-   *  with your "regular" collection since the actual proxying is done by the iterator itself.
-   *  </p>
-   * @param aCollection a collection to be decorated by a ExceptionSuppressingCollection. Note that this should be your "regular" collection,&#xA; not a already proxied one (i.e. <code>Collection&lt;ExceptionSuppressingProxy&gt;</code>).
-   * @return the collection decorated by a ExceptionSuppressingCollection, or <code>null</code> if <code>aCollection</code> is <code>null</code>.&#xA; If <code>aCollection</code> is a <code>ExceptionSuppressingCollection</code>),&#xA; <code>aCollection</code> will be returned "as-is" (no new instance will be created).
+   * Deprecated get method for deprecated ExceptionSuppressingCollection.
+   * @param aCollection a collection to be decorated by a ExceptionSuppressingCollection
+   * @return a deprecated ExceptionSuppressingCollection, or null if aCollection is null.
    * @since Sitevision 2.6.1_09
+   * @deprecated ExceptionSuppressingCollection is not supported, this method deprecated and will be removed in a future version of Sitevision
    */
   getExceptionSuppressingCollection(
     aCollection: Collection | unknown[]
   ): ExceptionSuppressingCollection;
 
   /**
-   * Creates and returns an instance of an exception-suppressing iterator that returns exception-suppressing dynamic proxys.
-   * @param anIterator an iterator to be decorated by a ExceptionSuppressingIterator
-   * @return the iterator decorated by a ExceptionSuppressingIterator, or <code>null</code> if <code>anIterator</code> is <code>null</code>.&#xA; If <code>anIterator</code> is a <code>ExceptionSuppressingIterator</code>),&#xA; <code>anIterator</code> will be returned "as-is" (no new instance will be created).
+   * Deprecated get method for deprecated ExceptionSuppressingIterator.
+   * @param aIterator an iterator to be decorated by a ExceptionSuppressingIterator
+   * @return a deprecated ExceptionSuppressingIterator, or null if aIterator is null.
    * @since Sitevision 2.6.1_09
+   * @deprecated ExceptionSuppressingIterator is not supported, this method deprecated and will be removed in a future version of Sitevision
    */
   getExceptionSuppressingIterator(
-    anIterator: Iterator
+    aIterator: Iterator
   ): ExceptionSuppressingIterator;
 
   /**

package/server/VelocityRenderer/index.d.ts

@@ -18,7 +18,7 @@ import type { String } from "../../types/java/lang/String";
  *     <p style="margin-top:0; margin-bottom:10px">
  *        <em>The upside of this is that you get caching and such "for free" and you don't have to include or use any Velocity jar
  *        when creating your portlet application (war file). You will also avoid possible Velocity.init() caveats and such.
- *        The possible downside is that the Velocity engine (currently version 1.7) potentially can be replaced at
+ *        The possible downside is that the Velocity engine and its features potentially can be replaced at
  *        any time (i.e. whenever Sitevision is updated).</em>
  *     </p>
  *     <p style="margin-top:0; margin-bottom:10px">
@@ -50,13 +50,13 @@ import type { String } from "../../types/java/lang/String";
  *        super.init(portletConfig);
  *
  *        template =
- *           " Current request is: $request &lt;br /&gt;                " +
- *           " Utils is: $sitevisionUtils &lt;br /&gt;                  " +
- *           " Session is: $jcrSession &lt;br /&gt;                     " +
- *           " VelocityEvaluator is: $velocityEvaluator &lt;br /&gt;    " +
- *           " &lt;br /&gt;                                             " +
+ *           " Current request is: $request &lt;br&gt;                  " +
+ *           " Utils is: $sitevisionUtils &lt;br&gt;                    " +
+ *           " Session is: $jcrSession &lt;br&gt;                       " +
+ *           " VelocityEvaluator is: $velocityEvaluator &lt;br&gt;      " +
+ *           " &lt;br&gt;                                               " +
  *           " #set($count = 1)                                   " +
- *           " This is written with the VelocityEvaluator: &lt;br /&gt; " +
+ *           " This is written with the VelocityEvaluator: &lt;br&gt;   " +
  *           " &lt;div style=\"margin:0 20px\"&gt;                      " +
  *           "    $velocityEvaluator.evaluate($evaluateThis)      " +
  *           " &lt;/div&gt;                                             ";
@@ -105,6 +105,7 @@ import type { String } from "../../types/java/lang/String";
  *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.0
+ * @deprecated portlet applications are the legacy way of extending Sitevision.&#xA; WebApp/RESTApp technique should be used instead as of Sitevision 5. This class will be removed in a future version of Sitevision.
  */
 export interface VelocityRenderer {
   /**
@@ -190,7 +191,7 @@ export interface VelocityRenderer {
   /**
    * Renders a Velocity template string.
    * @param aContext a context with mappings needed by aTemplate (Note! this must be an instance created via any of the methods above,&#xA; a custom VelocityContext implementation is not allowed).
-   * @param aTemplate the template string (i.e. if the actual template is in a file,&#xA; you must read it and put it in a string that can be passed to this method)
+   * @param aTemplate a String containing the Velocity code to be evaluated
    * @throws IllegalArgumentException if aTemplate is <code>null</code>, if aContext is <code>null</code> or not created via VelocityRenderer
    * @throws VelocityException if parsing/evaluation of aTemplate fails
    * @throws IOException if an I/O exception occurs during the rendering process

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

@@ -1,5 +1,5 @@
 /**
- * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy}.
+ * Get methods for accessing field constants defined in deprecated {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy}.
  *
  *  <p>
  *     The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy}
@@ -7,6 +7,7 @@
  *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
+ * @deprecated this interface is deprecated and will be removed in a future version of Sitevision
  */
 export type ExceptionSuppressingProxyConstants = {
   /**

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

@@ -8,48 +8,17 @@ import type { String } from "../../../../../../java/lang/String";
  *     context they were created for.
  *  </p>
  * @author Magnus Lövgren
- * @see VelocityRenderer
- * @since Sitevision 2.7_06
  * @since Sitevision 3.0
  */
 export type VelocityEvaluator = {
   /**
-   * Renders a template that is parsed/evaluated by Velocity.
+   * Renders a template string 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.
+   *     (e.g. <code>$aVelocityEvaluatorInstance.evaluate($aTemplateString)</code>).
    *  </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&#xA; (suffix must be ".vm" and path must not contain any space character)
+   * @param aTemplate a String containing the Velocity code to be evaluated
    */
   evaluate(aTemplate: String | string): void;
 };

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

@@ -10,7 +10,7 @@ import type { Requester } from "../../../../../../server/Requester";
  */
 export type RequesterChainable = Requester & {
   /**
-   * Invoked when a {@link Requester} was successfully executed.
+   * Invoked when a {@link Requester} was successfully executed (response with a status in the 2xx series).
    *
    *  <p>
    *     The callback is invoked with three optional arguments:
@@ -56,7 +56,7 @@ export type RequesterChainable = Requester & {
    *           </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>
+   *              <em>(Note! Will only be available for responses with a Content-Type header indicating the JSON format)</em>
    *           </li>
    *           <li>
    *              <em>headers</em> [@since Sitevision 4.5.1] - the potential response headers.

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts

@@ -2,94 +2,15 @@ import type { Iterator } from "../../../../../../java/util/Iterator";
 import type { Collection } from "../../../../../../java/util/Collection";
 
 /**
- * Decorates the iterator of a collection with a {@link ExceptionSuppressingIterator} to ensure exceptions are suppressed for all
- *  iterator invocations.
- *
- *  <p>
- *     The sole purpose of the <code>ExceptionSuppressingCollection</code> is to provide easy access to a decorated iterator
- *     (i.e. an {@link ExceptionSuppressingIterator}). You should <em>not</em> create a collection of exception suppressing proxys
- *     (i.e. <code>Collection&lt;ExceptionSuppressingProxy&gt;</code>) yourself. You should use <code>ExceptionSuppressingCollection</code>
- *     with your "regular" collection since the actual proxying is done by the iterator itself.
- *  </p>
- *  <p>
- *     Note that the <code>next</code> method of the interator returns an instance of a <em>Dynamic proxy</em> so not all methods can be invoked
- *     directly on the returned object. To invoke a method that is not proxied (i.e. a method not declared in an interface the object implements),
- *     you must extract the "real" object from the proxy and use that reference when invoking the method. See {@link ExceptionSuppressingIterator}
- *     for more information about the iterator and {@link ExceptionSuppressingProxy} for more information about dynamic proxies and how to extract
- *     "real" object.
- *  </p>
- *
- *  <p>
- *     <strong>Important note! </strong>This interface is intended to be used <em>only</em> in contexts where exceptions when iterating a
- *     collection will cause <em>serious</em> trouble if they arise and the context doesn't provide proper exception handling
- *     (e.g. when rendering a Velocity template). Suppressing exceptions is generally a bad idea and using this decorator will affect performance.
- *     Hence, this interface should only be used where the upsides with suppressing exceptions outweighs the downsides.
- *     This interface should be used only as a temporary patch/solution until the "real" problem causing the exception has been solved.
- *  </p>
- *
- *  <p>
- *     An instance of the Sitevision class implementing this interface can be obtained via
- *     {@link senselogic.sitevision.api.Utils#getExceptionSuppressingCollection(java.util.Collection)}.
- *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- *  </p>
- *
- *  <p>
- *  ----------------------------------------------------------------------------------------------------
- *  </p>
- *
- *  <p>
- *  <strong>Example of how <code>ExceptionSuppressingCollection</code> could be used in Velocity:</strong>
- *  </p>
- *
- *  <p>Case description:</p>
- *  <p>
- *     <em>You have a Velocity template where you iterate a collection. Sometimes a certain method throws an exception.
- *     The rendered output of the template gets corrupt whenever an exception is thrown and you have not yet tracked down the root
- *     cause of the exception. Until the root cause is found and the problem is fixed, you need a temporary solution that ignores
- *     exceptions to keep template output acceptable. Since the method is declared in an interface and implemented in the instance
- *     you're invoking, you're in sheer luck. You can decorate your collection with a <code>ExceptionSuppressingCollection</code>
- *     to get a decorated iterator. When interating, all returned elements are proxied by an <code>ExceptionSuppressingProxy</code>.
- *     Invoking the method through the proxy will suppress exceptions and you can diminish the output problems.
- *     Note that you should invoke the real object for all non-problematic methods and methods that can't be proxied
- *     (i.e. methods not declared in an interface). To get a reference to the real object,
- *     use {@link ExceptionSuppressingProxy#getProxiedObject()}.</em>
- *  </p>
- *  <p>
- *     This is what the code looks like before your temporary fix:
- *  </p>
- *  <pre><code>
- *     #foreach ($item in $myCollection)
- *        &lt;p&gt;
- *           $item.thisNeverThrowsExceptions()
- *           $item.thisMethodSometimesThrowsExceptions()
- *        &lt;/p&gt;
- *     #end
- *  </code></pre>
- *  <p>
- *     This is how you could use an <code>ExceptionSuppressingCollection</code> to apply a temporary fix:
- *  </p>
- *  <pre><code>
- *     <em>## Decorate collection</em>
- *     #set ($decoratedCollection = $sitevisionUtils.getExceptionSuppressingCollection($myCollection))
- *
- *     #foreach ($item in $decoratedCollection)
- *        &lt;p&gt;
- *           <em>## Get the real object and invoke non-problematic method as usual</em>
- *           #set ($realObject = $item.getProxiedObject())
- *
- *           $realObject.thisNeverThrowsExceptions()
- *           $!item.thisMethodSometimesThrowsExceptions() <em>## Executed through a proxy, might return null</em>
- *       &lt;/p&gt;
- *    #end
- *    &lt;/p&gt;
- *  </code></pre>
+ * Deprecated interface that will be removed in a future version of Sitevision.
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
+ * @deprecated this interface is deprecated and will be removed in a future version of Sitevision
  */
 export type ExceptionSuppressingCollection = Collection & {
   /**
-   * Returns an exception suppressing iterator that ensures no exceptions will be thrown during iteration.
-   * @return a {@link ExceptionSuppressingIterator} that suppresses exceptions and returns proxied items
+   * Returns a ExceptionSuppressingProxy Iterator for the decorated collection.
+   * @return a {@link ExceptionSuppressingIterator}
    */
   iterator(): Iterator;
 };

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts

@@ -3,32 +3,10 @@ import type { ExceptionSuppressingProxy } from "../ExceptionSuppressingProxy";
 import type { Iterator } from "../../../../../../java/util/Iterator";
 
 /**
- * Decorates an iterator with exception suppressing behaviour and returns {@link ExceptionSuppressingProxy}s in order to ensure that no
- *  invocation will throw an exception.
- *
- *  <p>
- *     This iterator is of type <code>ExceptionSuppressingProxy</code> that is an implementation of a <em>Dynamic proxy</em> so not all
- *     methods can be directly invoked on objects retrieved by the <code>next</code> method. See {@link ExceptionSuppressingCollection}
- *     for an example of how this iterator can be used easily from Velocity and how to invoke methods not declared in an interface.
- *     See {@link ExceptionSuppressingProxy} for more information about dynamic proxies.
- *  </p>
- *  <p>
- *  <strong>Important note! </strong>This interface is intended to be used <em>only</em> in contexts where exceptions thrown during iteration will
- *  cause <em>serious</em> trouble if they arise and the context doesn't provide proper exception handling (e.g. when executing a Velocity template).
- *  Suppressing exceptions is generally a bad idea and using this iterator will affect performance.
- *  Hence, this interface should only be used where the upsides with suppressing exceptions far outweighs the downsides.
- *  This interface should be used only as a temporary patch/solution until the "real" problem causing the exception has been solved.
- *  </p>
- *
- *  <p>
- *     An instance of the Sitevision class implementing this interface can be obtained directly via
- *     {@link senselogic.sitevision.api.Utils#getExceptionSuppressingIterator(java.util.Iterator)}
- *     or indirectly via {@link senselogic.sitevision.api.Utils#getExceptionSuppressingCollection(java.util.Collection)}.
- *     You would typically use the latter if you should iterate a collection with the Velocity #foreach loop.
- *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- *  </p>
+ * Deprecated interface that will be removed in a future version of Sitevision.
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
+ * @deprecated this interface is deprecated and will be removed in a future version of Sitevision
  */
 export type ExceptionSuppressingIterator = Iterator & {
   /**
@@ -36,47 +14,22 @@ export type ExceptionSuppressingIterator = Iterator & {
    *  if <code>next</code> would return an element rather than throwing an exception.)
    *
    *  <p>
-   *  This method will never throw an exception
+   *     This method will never throw an exception
    *  </p>
    * @return <code>true</code> if the decorated iterator has more elements, <code>false</code> if not or if an exception is thrown&#xA; by the decorated iterator
    */
   hasNext(): boolean;
 
   /**
-   * Returns a proxy for the next element of the decorated iterator. Calling this method repeatedly until the {@link #hasNext()} method
-   *  returns <code>false</code> will return each element in the underlying collection exactly once.
-   *
-   *  <p>
-   *     <strong>Note!</strong> The returned element will be embedded in an <code>ExceptionSuppressingProxy</code> that will be reused for
-   *     <em>all</em> next() invocations on this iterator. In other words, the proxied item of the returned element will change,
-   *     but never the returned element itself. This implies that you shouldn't keep references to an item retrieved from a next()
-   *     invocation during iteration. If you do, don't be surprised if the element contains something else than it did when you set the reference...
-   *  </p>
-   *
-   *  <p>
-   *  This method will never throw an exception.
-   *  </p>
-   *  <p>
-   *     <strong>Note! </strong>Be aware of <code>null</code> items since they're never proxied. If the underlying collection contains a
-   *     <code>null</code> item, this iterator will just return <code>null</code>, not a proxy. In other words: even though this method
-   *     won't throw any exceptions, invoking a method on the returned object might throw a <code>NullPointerException</code>.
-   *  </p>
-   * @return the next element, or <code>null</code> if an exception is thrown.
+   * Returns a ExceptionSuppressingProxy for the next element of the decorated iterator.
+   * @return the next element of the decorated iterator, or <code>null</code> if an exception is thrown.
    */
   next(): ExceptionSuppressingProxy;
 
   /**
- * Tries to remove from the underlying collection the last element returned by decorated iterator (optional operation).
- *  This method can be called only once per call to <code>next</code>. The behavior of an iterator is unspecified if
- *  the underlying collection is modified while the iteration is in progress in any way other than by calling this method.
- * 
- *  <p>
- *  This method will never throw an exception.
- *  </p>
+ * Tries to remove from the decorated iterator.
  *  <p>
- *  <strong>Note!</strong> Since exceptions are suppressed, you can never tell if the remove operation actually succeeded
- *  or if the underlying collection doesn't support removal (i.e. <code>UnsupportedOperationException</code> thrown by the
- *  decorated iterator is catched by this iterator).
+ *     This method will never throw an exception.
  *  </p>
   
     */

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts

@@ -3,90 +3,27 @@ import type { Object } from "../../../../../../java/lang/Object";
 import type { ExceptionSuppressingProxyConstants } from "../../../render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants";
 
 /**
- * Proxies an object and delegates all interface method invocations to the proxied object in order to ensure that no invocation
- *  will throw an exception.
- *
- *  <p>
- *     This interface is an exception suppressing implementation of a so called
- *     <em><a href="http://docs.oracle.com/javase/8/docs/technotes/guides/reflection/proxy.html">Dynamic proxy</a></em>.
- *     This means it will proxy all methods of an object that are declared in an interface implemented by the object.
- *     If a method invocation through this proxy throws an <code>Exception</code>, it will be catched and the default value will be returned
- *     (e.g. <code>null</code>, <code>0</code>, <code>false</code> etc).
- *  </p>
- *
- *  <p>
- *     <strong>Important note! </strong>This interface is intended to be used <em>only</em> in contexts where exceptions will cause <em>serious</em>
- *     trouble if they arise and the context doesn't provide proper exception handling (e.g. when executing a Velocity template).
- *     Suppressing exceptions is generally a <em>really</em> bad idea and using this proxy will affect performance.
- *     Hence, this interface should only be used where the upsides with suppressing exceptions far outweighs the downsides.
- *     This interface should be used only as a temporary patch/solution until the "real" problem causing the exception has been solved.
- *  </p>
- *
- *  <p>
- *     The state of an ExceptionSuppressingProxy is available at all times and updated for each method invocation
- *     (except for invocations of methods declared in this interface).
- *     If last method invocation resulted in a thrown exception the proxy status will be {@link #EXCEPTION_THROWN_STATUS}
- *     and the exception will be available via {@link #getCurrentException()}.
- *  </p>
- *
- *  <p>
- *     An instance of the Sitevision class implementing this interface can be obtained via
- *     {@link senselogic.sitevision.api.Utils#getExceptionSuppressingProxy(Object)}.
- *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- *  </p>
- *
- *  <p>
- *  ----------------------------------------------------------------------------------------------------
- *  </p>
- *
- *  <p>
- *  <strong>Example of how <code>ExceptionSuppressingProxy</code> could be used in Velocity:</strong>
- *  </p>
- *
- *  <p>Case description:</p>
- *  <p>
- *     <em>You have a Velocity template where a certain method invocation sometimes throws an exception.
- *     The rendered output of the template gets corrupt whenever an exception is thrown and you have not yet tracked down the root cause
- *     of the exception. Until the root cause is found and the problem is fixed, you need a temporary solution that ignores exceptions
- *     to keep template output acceptable. Since the method is declared in an interface and implemented in the instance you're invoking,
- *     you're in sheer luck. You can use an <code>ExceptionSuppressingProxy</code> to suppress exceptions in order to diminish output
- *     problems.</em><p>This is what the code looks like before your temporary fix:
- *  </p>
- *  <pre><code>
- *     &lt;p&gt;
- *        $myObject.thisNeverThrowsExceptions()
- *        $myObject.thisMethodSometimesThrowsExceptions() <em>## This method is declared in an interface, hence can be proxied</em>
- *     &lt;/p&gt;
- *  </code></pre>
- *  This is how you could use an <code>ExceptionSuppressingProxy</code> to apply a temporary fix:<pre><code>
- *     &lt;p&gt;
- *        $myObject.thisNeverThrowsExceptions()
- *
- *        <em>## Get an ExceptionSuppressingProxy instance for myObject</em>
- *        #set ($proxy = $sitevisionUtils.getExceptionSuppressingProxy($myObject))
- *
- *        $!proxy.thisMethodSometimesThrowsExceptions() <em>## Method invoked through a proxy, might return null</em>
- *     &lt;/p&gt;
- *  </code></pre>
+ * Deprecated interface that will be removed in a future version of Sitevision.
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
+ * @deprecated this interface is deprecated and will be removed in a future version of Sitevision
  */
 export type ExceptionSuppressingProxy = ExceptionSuppressingProxyConstants & {
   /**
-   * Returns current status
-   * @return {@link #NO_OBJECT_PROXIED_STATUS} or {@link #NO_EXCEPTION_THROWN_STATUS} or {@link #EXCEPTION_THROWN_STATUS}
+   * Always returns {@link #NO_EXCEPTION_THROWN_STATUS}.
+   * @return {@link #NO_EXCEPTION_THROWN_STATUS}
    */
   getCurrentStatus(): number;
 
   /**
-   * Returns the exception that was thrown during last method invocation of the proxied object.
-   * @return the exception thrown during last method invocation, or <code>null</code> if no exeption was thrown
+   * Always returns null.
+   * @return null
    */
   getCurrentException(): Exception;
 
   /**
-   * Returns the proxied object
-   * @return the object that is proxied by an instance of this interface, or <code>null</code> if no proxied object is set
+   * Returns the object this ExceptionSuppressingProxy was created for.
+   * @return the decorated object
    */
   getProxiedObject(): unknown;