@sitevision/api 2025.5.1 → 2025.7.1

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.5.1",
+  "version": "2025.7.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -30,5 +30,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "28570281cd01424c7ed0772fb5a5f004c92712b1"
+  "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/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;
 }
 
 /**

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.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() {}
 };