@sitevision/api 2025.4.2 → 2025.7.1

package/server/aiAssistant/index.d.ts

@@ -0,0 +1,197 @@
+import aiAssistant from '.';
+import type { Node } from '../../types/javax/jcr/Node';
+import type { Message, StreamFinishResult, UsageInfo } from '../ai';
+
+export type SemanticQueryOptions = {
+  /**
+   * The query, typically the user message to be used in a conversation
+   */
+  query: string;
+
+  /**
+   * Max number of chunks. Valid numbers are between 1 and 20 and the default is 5.
+   */
+  maxHits?: number;
+};
+
+export type AskAssistantOptions = {
+  /**
+   * The user message in the conversation
+   */
+  message: string;
+
+  /**
+   * The key that identifies the conversation for current user
+   */
+  conversationIdentifier: string;
+
+  /**
+   * The potential knowledge needed to answer the user question/message (optional).
+   * A provided knowledge value will be included in the system message/prompt of this conversation. The value will replace potentially previous knowledge.
+   *
+   * Hints. This value is typically extracted via the querySemanticIndex method. And potential existing knowledge in the conversation can be retrieved via the getConversationKnowledge method.
+   */
+  knowledge?: string | string[];
+
+  /**
+   * Callback function that is triggered for each received token.
+   * The function receives the token as a string.
+   *
+   * @param token The streamed token received from the AI model.
+   */
+  onChunk: (token: string) => void;
+
+  /**
+   * Callback function triggered when the streaming operation completes.
+   *
+   * @param result The final result of the stream operation.
+   */
+  onFinish: (result: StreamFinishResult) => void;
+  /**
+   * Maximum duration (in milliseconds) before timing out.
+   * The default value and valid range are environment-dependent and can be
+   * configured via a system property. If not explicitly set, the system
+   * determines an appropriate timeout value.
+   */
+  timeout?: number;
+
+  /**
+   * The maximum number of tokens (words/word fragments) the model can generate.
+   */
+  maxTokens?: number;
+
+  /**
+   * Controls response randomness:
+   * - Lower values (e.g., 0) make responses deterministic.
+   * - Higher values (e.g., 1) increase variability.
+   */
+  temperature?: number;
+
+  /**
+   * Reduces repeated token usage in generated text.
+   * Higher values promote more diverse output.
+   */
+  frequencyPenalty?: number;
+};
+
+export type AskLLMOptions = {
+  /**
+   * Messages that represent a conversation
+   */
+  messages: Message[];
+
+  /**
+   * The maximum amount of time, in milliseconds, that Sitevision will wait for a response before the connection times out.
+   * Default 30000 (30s)
+   */
+  timeout?: number;
+
+  /**
+   * Specifies the maximum number of tokens (words or word fragments) that the model can generate in the response. This includes both the prompt and the completion.
+   */
+  maxTokens?: number;
+
+  /**
+   * Controls the randomness or creativity of the model's output. Lower values make the output more deterministic and focused, while higher values introduce more variability and creativity.
+   */
+  temperature?: number;
+
+  /**
+   * Penalizes the model for using the same tokens repeatedly. A higher value reduces the likelihood of repeating the same phrases, promoting more diverse language usage.
+   */
+  frequencyPenalty?: number;
+};
+
+export type KnowledgeEntry = {
+  /**
+   * The unique identifier for the source of the knowledge.
+   */
+  id: string;
+
+  /**
+   * The knowledge text, typically a string.
+   */
+  text: string;
+};
+
+export type LLMResponse = {
+  text: string;
+
+  error: string;
+
+  finishReason: string;
+
+  usage: UsageInfo;
+};
+
+/**
+ * AI SDK for interacting with Large Language Models (LLMs).
+ */
+export interface AIAssistant {
+  /**
+   * Returns a new, unique conversationIdentifier string - the key needed to identify a conversation for current user.
+   * @param aiAssistant The AI Assistant instance.
+   * @returns A unique conversation identifier string.
+   */
+  createConversation(aiAssistant: Node): string;
+
+  /**
+   * Retrieves the memory (context) of a specific conversation. Will not include any system messages.
+   *
+   * @param aiAssistant The AI Assistant instance.
+   * @param conversationIdentifier The unique identifier of the conversation.
+   * @returns An array of messages representing the conversation memory.
+   */
+  getConversationMemory(
+    aiAssistant: Node,
+    conversationIdentifier: string
+  ): Message[];
+
+  /**
+   * Retrieves the knowledge string used in the conversation.
+   *
+   * @param aiAssistant The AI Assistant instance.
+   * @param conversationIdentifier The unique identifier of the conversation.
+   * @returns A string representing the conversation knowledge.
+   */
+  getConversationKnowledge(
+    aiAssistant: Node,
+    conversationIdentifier: string
+  ): string;
+
+  /**
+   * Queries a semantic index for knowledge entries based on the provided options.
+   *
+   * @param aiAssistant The AI Assistant instance.
+   * @param options Options for the semantic query.
+   * @returns An array of knowledge entries matching the query.
+   */
+  querySemanticIndex(
+    aiAssistant: Node,
+    options: SemanticQueryOptions
+  ): KnowledgeEntry[];
+
+  /**
+   * Asks the AI Assistant a question and will receive a streamed response.
+   *
+   * @param aiAssistant The AI Assistant instance.
+   * @param options Options for the assistant query.
+   */
+  askAssistant(aiAssistant: Node, options: AskAssistantOptions);
+
+  /**
+   * Method to generate text using the LLM of an AI Assistant configuration. Useful for non-interactive use cases such as summarization,
+   * @param aiAssistant The AI Assistant instance.
+   * @param options Options for the LLM query.
+   */
+  askLLM(aiAssistant: Node, options: AskLLMOptions): LLMResponse;
+}
+
+declare namespace AIAssistant {}
+
+/**
+ * The AI Assistant SDK instance.
+ */
+declare var aiAssistant: AIAssistant;
+
+export default aiAssistant;

package/server/aiAssistant/index.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = exports["default"] = {
+  createConversation: function createConversation() {},
+  getConversationMemory: function getConversationMemory() {},
+  getConversationKnowledge: function getConversationKnowledge() {},
+  querySemanticIndex: function querySemanticIndex() {},
+  askAssistant: function askAssistant() {},
+  askLLM: function askLLM() {}
+};

package/types/senselogic/sitevision/api/render/TextModuleRenderer/index.d.ts

@@ -20,6 +20,10 @@ import type { String } from "../../../../../java/lang/String";
  *        This renderer provides the ability to render <em>"plain" HTML</em> output for a Text module
  *        <em>(typically what you want when the HTML of the Text module should be used outside of Sitevision, i.e. headless)</em>.
  *     </li>
+ *     <li>
+ *        This renderer also supports rendering output as <em>Markdown</em>,
+ *        which is particularly useful for large language model (LLM) applications and other modern content workflows.
+ *    </li>
  *  </ul>
  *
  *  <p>
@@ -43,14 +47,15 @@ import type { String } from "../../../../../java/lang/String";
  *
  *  <p>
  *     <strong>Example of how this renderer could be used:</strong><br>
- *     E.g. You want to get all output types (html, plain html, text) from two Text modules on a specific page.
+ *     E.g. You want to get all output types (html, plain html, text, markdown) from two Text modules on a specific page.
  *  </p>
  *  <pre><code>   var textRendererBuilder = require('TextModuleRendererBuilder'),
  *        textRenderer,
  *        page,
  *        htmlData = { "type": "HTML" },
  *        plainHtmlData = { "type": "Plain HTML" },
- *        textData = { "type": "Text" };
+ *        textData = { "type": "Text" },
+ *        markdownData = { "type": "Markdown" };
  *
  *    <em>// Get the page where the Text modules are located...</em>
  *    page = ...
@@ -64,6 +69,7 @@ import type { String } from "../../../../../java/lang/String";
  *       htmlData.heading = textRenderer.renderHtml();
  *       plainHtmlData.heading = textRenderer.renderPlainHtml();
  *       textData.heading = textRenderer.renderText();
+ *       markdownData.heading = textRenderer.renderMarkdown();
  *    }
  *
  *    <em>// Update the TextModuleRenderer with another Text module and render (if possible)</em>
@@ -72,6 +78,7 @@ import type { String } from "../../../../../java/lang/String";
  *       htmlData.content = textRenderer.renderHtml();
  *       plainHtmlData.content = textRenderer.renderPlainHtml();
  *       textData.content = textRenderer.renderText();
+ *       markdownData.content = textRenderer.renderMarkdown();
  *    }</code></pre>
  *  <p>
  *     The JSON result of the Javascript objects in the example script above could be something like this:
@@ -95,6 +102,13 @@ import type { String } from "../../../../../java/lang/String";
  *       "type": "Text",
  *       "heading": "Heading",
  *       "content": "Some content"
+ *    }
+ *
+ *    <strong>// markdownData</strong>
+ *    {
+ *       "type": "Markdown",
+ *       "heading": "# Heading",
+ *       "content": "Some content"
  *    }</code></pre>
  *
  *  <p>
@@ -231,4 +245,16 @@ export type TextModuleRenderer = {
    * @see #renderHtml()
    */
   renderPlainHtml(): string;
+
+  /**
+   * Renders Markdown for the loaded Text module.
+   *
+   *  <p>
+   *  <strong>Note!</strong> The returned value will always be empty string if the {@link #isLoaded()} state is <code>false</code>
+   *  when invoking this render method <em>(i.e. you would typically always check the loaded state before calling this method).</em>
+   *  </p>
+   * @return the Markdown representation of the loaded Text module, or empty String if rendering fails or no Text module is loaded
+   * @since Sitevision 2025.07.1
+   */
+  renderMarkdown(): string;
 };

package/types/senselogic/sitevision/api/render/TextModuleRenderer/index.js

@@ -11,5 +11,6 @@ var _default = exports["default"] = {
   isLoaded: function isLoaded() {},
   renderHtml: function renderHtml() {},
   renderText: function renderText() {},
-  renderPlainHtml: function renderPlainHtml() {}
+  renderPlainHtml: function renderPlainHtml() {},
+  renderMarkdown: function renderMarkdown() {}
 };

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/VelocityAccess.NodeTypeUtilConstants/index.d.ts

@@ -1367,6 +1367,13 @@ export type NodeTypeUtilConstants = {
    */
   getTARGET_AUDIENCE_TYPE(): string;
 
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#TARGET_AUDIENCE_GROUP_REPOSITORY_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#TARGET_AUDIENCE_GROUP_REPOSITORY_TYPE}
+   * @since Sitevision 2025.07.1
+   */
+  getTARGET_AUDIENCE_GROUP_REPOSITORY_TYPE(): string;
+
   /**
    * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#TARGET_AUDIENCE_GROUP_TYPE}.
    * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#TARGET_AUDIENCE_GROUP_TYPE}
@@ -1422,4 +1429,18 @@ export type NodeTypeUtilConstants = {
    * @since Sitevision 2025.03.1
    */
   getSEMANTIC_INDEX_REPOSITORY_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#AI_ASSISTANT_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#AI_ASSISTANT_TYPE}
+   * @since Sitevision 2025.07.1
+   */
+  getAI_ASSISTANT_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#AI_ASSISTANT_REPOSITORY_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#AI_ASSISTANT_REPOSITORY_TYPE}
+   * @since Sitevision 2025.07.1
+   */
+  getAI_ASSISTANT_REPOSITORY_TYPE(): string;
 };

package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js

@@ -203,6 +203,7 @@ var _default = exports["default"] = {
   getCSS_RULE_TYPE: function getCSS_RULE_TYPE() {},
   getTARGET_AUDIENCE_REPOSITORY_TYPE: function getTARGET_AUDIENCE_REPOSITORY_TYPE() {},
   getTARGET_AUDIENCE_TYPE: function getTARGET_AUDIENCE_TYPE() {},
+  getTARGET_AUDIENCE_GROUP_REPOSITORY_TYPE: function getTARGET_AUDIENCE_GROUP_REPOSITORY_TYPE() {},
   getTARGET_AUDIENCE_GROUP_TYPE: function getTARGET_AUDIENCE_GROUP_TYPE() {},
   getMETADATA_SINGLE_TARGET_AUDIENCE_DEFINITION_TYPE: function getMETADATA_SINGLE_TARGET_AUDIENCE_DEFINITION_TYPE() {},
   getMETADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE: function getMETADATA_MULTIPLE_TARGET_AUDIENCE_DEFINITION_TYPE() {},
@@ -210,5 +211,7 @@ var _default = exports["default"] = {
   getMETADATA_GEOLOCATION_DEFINITION_TYPE: function getMETADATA_GEOLOCATION_DEFINITION_TYPE() {},
   getMETADATA_MODULE_DEFINITION_TYPE: function getMETADATA_MODULE_DEFINITION_TYPE() {},
   getSEMANTIC_INDEX_TYPE: function getSEMANTIC_INDEX_TYPE() {},
-  getSEMANTIC_INDEX_REPOSITORY_TYPE: function getSEMANTIC_INDEX_REPOSITORY_TYPE() {}
+  getSEMANTIC_INDEX_REPOSITORY_TYPE: function getSEMANTIC_INDEX_REPOSITORY_TYPE() {},
+  getAI_ASSISTANT_TYPE: function getAI_ASSISTANT_TYPE() {},
+  getAI_ASSISTANT_REPOSITORY_TYPE: function getAI_ASSISTANT_REPOSITORY_TYPE() {}
 };

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/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>
   
     */