@sitevision/api 2025.4.2 → 2025.7.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/index.d.ts

@@ -134,6 +134,7 @@ import './server/WebResourceFactory';
 import './server/XSLTUtil';
 import './server/XmlParserUtil';
 import './server/ai';
+import './server/aiAssistant';
 import './server/appData';
 import './server/appInfo';
 import './server/appResource';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2025.4.2",
+  "version": "2025.7.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -30,5 +30,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "92b180a863333a8130e6b869ae0098ff2053f45d"
+  "gitHead": "771eb380b026a8b6df85ac5c55a83dfa55b9a179"
 }

package/server/FileIconRenderer/index.d.ts

@@ -152,6 +152,7 @@ import type { String } from "../../types/java/lang/String";
  *  </ul>
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_08
+ * @deprecated
  */
 export interface FileIconRenderer {
   /**

package/server/IconUtil/index.d.ts

@@ -9,6 +9,7 @@ import type { Node } from "../../types/javax/jcr/Node";
  *  See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
  *  </p>
  * @author Magnus Lövgren
+ * @deprecated
  */
 export interface IconUtil {
   /**

package/server/NodeTypeUtil/index.d.ts

@@ -734,6 +734,18 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    */
   SEMANTIC_INDEX_REPOSITORY_TYPE: "sv:semanticIndexRepository";
 
+  /**
+   * The primary node type name for the ai assistant type.
+   * @since Sitevision 2025.07.1
+   */
+  AI_ASSISTANT_TYPE: "sv:aiAssistant";
+
+  /**
+   * The primary node type name for the ai assistant repository type.
+   * @since Sitevision 2025.07.1
+   */
+  AI_ASSISTANT_REPOSITORY_TYPE: "sv:aiAssistantRepository";
+
   /**
    * The primary node type name for the simple user type.
    * @see #isSimpleUser(Node)
@@ -1242,6 +1254,12 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    */
   TARGET_AUDIENCE_TYPE: "sv:targetAudience";
 
+  /**
+   * The primary node type name for the target audience group repository type.
+   * @since SiteVision 2025.07.1
+   */
+  TARGET_AUDIENCE_GROUP_REPOSITORY_TYPE: "sv:targetAudienceGroupRepository";
+
   /**
    * The primary node type name for the target audience group type.
    * @since Sitevision 2024.09.2

package/server/ResourceLocatorUtil/index.d.ts

@@ -495,6 +495,20 @@ export interface ResourceLocatorUtil {
    * @since Sitevision 2025.03.1
    */
   getSemanticIndexRepository(): Node;
+
+  /**
+   * Gets the target audience group repository (sv:targetAudienceGroupRepository) for the site of current node.
+   * @return the target audience group repository, or null if indeterminable.
+   * @since Sitevision 2025.07.1
+   */
+  getTargetAudienceGroupRepository(): Node;
+
+  /**
+   * Gets the ai assistant repository (sv:aiAssistantRepository) for the site of current node.
+   * @return the ai assistant repository, or null if indeterminable.
+   * @since Sitevision 2025.07.1
+   */
+  getAiAssistantRepository(): Node;
 }
 
 declare namespace ResourceLocatorUtil {}

package/server/ResourceLocatorUtil/index.js

@@ -52,5 +52,7 @@ var _default = exports["default"] = {
   getCssRuleRepository: function getCssRuleRepository() {},
   getLlmConfigurationRepository: function getLlmConfigurationRepository() {},
   getTargetAudienceRepository: function getTargetAudienceRepository() {},
-  getSemanticIndexRepository: function getSemanticIndexRepository() {}
+  getSemanticIndexRepository: function getSemanticIndexRepository() {},
+  getTargetAudienceGroupRepository: function getTargetAudienceGroupRepository() {},
+  getAiAssistantRepository: function getAiAssistantRepository() {}
 };

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/server/ai/index.d.ts

@@ -29,8 +29,8 @@ export interface GenerateTextOptions {
 
   /**
    * 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 
+   * 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;
@@ -99,8 +99,8 @@ export interface StreamTextOptions {
 
   /**
    * 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 
+   * 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;
@@ -139,6 +139,15 @@ export interface StreamTextOptions {
   onFinish: (result: StreamFinishResult) => void;
 }
 
+/**
+ * Contains token usage information for the request. Note that usage may vary and may not be supported by some models.
+ */
+export type UsageInfo = {
+  promptTokens: number;
+  completionTokens: number;
+  totalTokens: number;
+};
+
 /**
  * Final result object for a streaming text operation.
  */
@@ -164,13 +173,9 @@ export interface StreamFinishResult {
   finishReason: string;
 
   /**
-   * (Optional) Token usage statistics for this request.
+   * Token usage statistics for this request.
    */
-  usage?: {
-    promptTokens: number;
-    completionTokens: number;
-    totalTokens: number;
-  };
+  usage: UsageInfo;
 }
 
 /**