@sitevision/api 2025.10.1 → 2026.1.1

package/server/RendererBuilderFactory/index.d.ts

@@ -0,0 +1,44 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
+import type { TextModuleRendererBuilder } from "../TextModuleRendererBuilder";
+import type { ContentRendererBuilder } from "../ContentRendererBuilder";
+
+/**
+ * Factory for creating various builders for rendering page content.
+ *
+ *  <p>
+ *     Currently, the factory can create builders for rendering of <strong>content nodes on a given page</strong>:
+ *  </p>
+ *  <ul>
+ *     <li>Use {@link #getTextModuleRendererBuilder()} to create a renderer for Text modules.</li>
+ *     <li>Use {@link #getContentRendererBuilder()} to create a renderer for other type of content nodes (i.e. layouts, modules etc).</li>
+ *  </ul>
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.Utils#getRendererBuilderFactory()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 2026.01.1
+ */
+export interface RendererBuilderFactory {
+  /**
+   * Gets a TextModuleRendererBuilder instance.
+   * @return a TextModuleRendererBuilder instance
+   */
+  getTextModuleRendererBuilder(): TextModuleRendererBuilder;
+
+  /**
+   * Gets a ContentRendererBuilder instance.
+   * @return a ContentRendererBuilder instance
+   */
+  getContentRendererBuilder(): ContentRendererBuilder;
+}
+
+declare namespace RendererBuilderFactory {}
+
+declare var rendererBuilderFactory: RendererBuilderFactory;
+
+export default rendererBuilderFactory;

package/server/RendererBuilderFactory/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
+var _default = exports["default"] = {
+  getTextModuleRendererBuilder: function getTextModuleRendererBuilder() {},
+  getContentRendererBuilder: function getContentRendererBuilder() {}
+};

package/server/TagUtil/index.d.ts

@@ -47,7 +47,8 @@ export interface TagUtil {
    *
    *  <p>
    *     <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
-   *     permission on the taggable Node that is mutated.
+   *     permission on the taggable Node that is mutated. <em>Note that members of a sv:collaborationGroup is also allowed to add tags
+   *     for the group files.</em>
    *  </p>
    *  <p>
    *     <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the
@@ -68,7 +69,8 @@ export interface TagUtil {
    *
    *  <p>
    *     <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
-   *     permission on the taggable Node that is mutated.
+   *     permission on the taggable Node that is mutated. <em>Note that members of a sv:collaborationGroup is also allowed to add tags
+   *     for the group files.</em>
    *  </p>
    *  <p>
    *     <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the
@@ -99,7 +101,8 @@ export interface TagUtil {
    *
    *  <p>
    *     <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
-   *     permission on the taggable Node that is mutated.
+   *     permission on the taggable Node that is mutated. <em>Note that members of a sv:collaborationGroup is also allowed to remove tags
+   *     for the group files.</em>
    *  </p>
    *  <p>
    *     <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the

package/server/TextModuleRendererBuilder/index.d.ts

@@ -45,8 +45,8 @@ import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder
  *
  *  <p>
  *     An instance of the Sitevision class implementing this interface can be obtained via
- *     {@link senselogic.sitevision.api.Utils#getTextModuleRendererBuilder()}.
- *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>TextModuleRendererBuilder</code> interface.
+ *     {@link RendererBuilderFactory#getTextModuleRendererBuilder()}.
+ *     See {@link RendererBuilderFactory} for how to obtain an instance of the <code>RendererBuilderFactory</code> interface.
  *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 7

package/server/Utils/index.d.ts

@@ -90,6 +90,8 @@ import type { TagUtil } from "../TagUtil";
 import type { AliasUtil } from "../AliasUtil";
 import type { MessagesFactory } from "../MessagesFactory";
 import type { TargetAudienceUtil } from "../TargetAudienceUtil";
+import type { RendererBuilderFactory } from "../RendererBuilderFactory";
+import type { CreateContentFactory } from "../CreateContentFactory";
 
 /**
  * Main entry point to get instances of interfaces in the Sitevision Utility API.
@@ -754,6 +756,20 @@ export interface Utils {
    * @since Sitevision 2024.09.2
    */
   getTargetAudienceUtil(): TargetAudienceUtil;
+
+  /**
+   * Gets an instance of a renderer builder factory class.
+   * @return a renderer builder factory class
+   * @since Sitevision 2026.01.1
+   */
+  getRendererBuilderFactory(): RendererBuilderFactory;
+
+  /**
+   * Gets an instance of a content builder factory.
+   * @return a content builder factory.
+   * @since Sitevision 2026.01.1
+   */
+  getCreateContentFactory(): CreateContentFactory;
 }
 
 declare namespace Utils {}

package/server/Utils/index.js

@@ -92,5 +92,7 @@ var _default = exports["default"] = {
   getTagUtil: function getTagUtil() {},
   getAliasUtil: function getAliasUtil() {},
   getMessagesFactory: function getMessagesFactory() {},
-  getTargetAudienceUtil: function getTargetAudienceUtil() {}
+  getTargetAudienceUtil: function getTargetAudienceUtil() {},
+  getRendererBuilderFactory: function getRendererBuilderFactory() {},
+  getCreateContentFactory: function getCreateContentFactory() {}
 };

package/server/ai/index.d.ts

@@ -1,5 +1,22 @@
 import type { Node } from '../../types/javax/jcr/Node';
 
+/**
+ * Represents a text part of a message.
+ */
+export interface TextPart {
+  type: 'text';
+  text: string;
+}
+
+/**
+ * Represents an image part of a message.
+ */
+export interface ImagePart {
+  type: 'image';
+  image: string;
+  mimeType: string;
+}
+
 /**
  * Represents a message in an AI conversation.
  */
@@ -14,8 +31,9 @@ export interface Message {
 
   /**
    * The actual content of the message.
+   * Can be either a string or an array of text and image parts.
    */
-  content: string;
+  content: string | Array<TextPart | ImagePart>;
 }
 
 /**

package/types/senselogic/sitevision/api/metadata/value/GeolocationValue/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
+
+/**
+ * A temporary representation of a geolocation metadata value.
+ *
+ *  <p>
+ *     An instance of this interface can be used in MetadataUtil when setting a geolocation metadata via the
+ *     {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, String, Object)}
+ *     or
+ *     {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property, Object)}
+ *  </p>
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.metadata.builder.GeolocationValueBuilder#build()}.
+ *     See {@link senselogic.sitevision.api.metadata.builder.GeolocationValueBuilder} for how to obtain an instance of the
+ *     <code>GeolocationValueBuilder</code> interface.
+ *  </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 2025.11.1
+ * @see senselogic.sitevision.api.metadata.builder.GeolocationValueBuilder
+ */
+export type GeolocationValue = {};

package/types/senselogic/sitevision/api/metadata/value/GeolocationValue/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
+var _default = exports["default"] = {};

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

@@ -0,0 +1,127 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
+import type { Node } from "../../../../../javax/jcr/Node";
+
+import type { String } from "../../../../../java/lang/String";
+
+/**
+ * ContentRenderer is a stateful renderer of content on a specific page.
+ *
+ *  <p>
+ *     This rendering utility is a page content-specific sibling to {@link OutputUtil#getNodeOutput(Node, Node, int)}
+ *     but it has some nifty advantages:
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        This renderer is more <em>efficient</em> than {@code OutputUtil} for subsequent rendering of page content.
+ *     </li>
+ *     <li>
+ *        This renderer provides <em>convenience methods</em> for easy access of page content to render.
+ *     </li>
+ *     <li>
+ *        This renderer can use request <em>parameters</em> when rendering page content (if created via the {@link ContentRendererBuilder}).
+ *     </li>
+ *  </ul>
+ *
+ *  <p>
+ *     <strong>Note!</strong> This renderer has generic support for page content (i.e. modules, layouts etc.)
+ *     but if you should render <em>Text modules</em> - you should use {@link TextModuleRenderer} instead!
+ *     The TextModuleRenderer is much, much more efficient and provides more versatile behaviour when rendering text modules.
+ *  </p>
+ *
+ *  <p>
+ *    Using the ContentRenderer is pretty straightforward, if you remember that it is <strong>stateful</strong> and it adheres to an immutable page
+ *    determined at creation time.<br>
+ *    Conceptually you would typically use it like this:
+ *  </p>
+ *  <ol>
+ *    <li>Get the ContentRenderer for a specific page and parameters via {@link ContentRendererBuilder}.</li>
+ *    <li>Update the renderer with a content node on the page.</li>
+ *    <li>Check if the renderer is loaded (i.e. could the update process resolve a valid/renderable content node).</li>
+ *    <li>Do render</li>
+ *  </ol>
+ *  <p>
+ *     When you have rendered once, you can re-use the ContentRenderer until you are done. Something like:
+ *  </p>
+ *  <ol>
+ *    <li>Update the renderer with a another content node on the page.</li>
+ *    <li>Check if the renderer is loaded (i.e. could the update process resolve a valid/renderable content node).</li>
+ *    <li>Do render</li>
+ *  </ol>
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link ContentRendererBuilder#build()} .
+ *     See {@link ContentRendererBuilder} for how to obtain an instance of the <code>ContentRendererBuilder</code> interface.
+ *  </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 2026.01.1
+ * @see ContentRendererBuilder
+ */
+export type ContentRenderer = {
+  /**
+   * Updates the state of this renderer using a content Node.
+   *
+   *  <p>
+   *     <em>
+   *        Note! If this state update fails (i.e. argument was null or not specifying a supported content part that exists on the page
+   *        this renderer was created for) there will be nothing to render. The state can always be checked via the
+   *        {@link #isLoaded()} method.
+   *     </em>
+   *  </p>
+   * @param aContentNode the content node, typically a sv:portlet, sv:layout or sv:referenceLayout
+   */
+  update(aContentNode: Node): void;
+
+  /**
+   * Updates the state of this renderer using the identifier of a content Node.
+   *
+   *  <p>
+   *     The "identifier" is the JCR Node identifier (also the <code>jcr:uuid</code> property) of the content node.
+   *  </p>
+   *  <p>
+   *     <em>
+   *        Note! If this state update fails (i.e. argument was null or not specifying a supported content part that exists on the page
+   *        this renderer was created for) there will be nothing to render. The state can always be checked via the
+   *        {@link #isLoaded()} method.
+   *     </em>
+   *  </p>
+   * @param aNodeIdentifier the node identifier that specifies the content node (typically a sv:portlet, sv:layout or sv:referenceLayout)
+   */
+  updateByIdentifier(aNodeIdentifier: String | string): void;
+
+  /**
+   * Updates the state of this renderer using the content identifier of a content Node.
+   *
+   *  <p>
+   *     The "content identifier" is the <code>contentIdentifier</code> property for the sv:portlet on the context page.
+   *  </p>
+   *  <p>
+   *     <em>
+   *        Note! If this state update fails (i.e. argument was null or not specifying a supported content part that exists on the page
+   *        this renderer was created for) there will be nothing to render. The state can always be checked via the
+   *        {@link #isLoaded()} method.
+   *     </em>
+   *  </p>
+   * @param aContentIdentifier the content identifier that specifies the content node (i.e. a sv:portlet)
+   */
+  updateByContentIdentifier(aContentIdentifier: String | string): void;
+
+  /**
+   * Whether this renderer has been updated with a renderable content Node.
+   * @return true if this renderer has a valid content Node to render, false otherwise
+   */
+  isLoaded(): boolean;
+
+  /**
+   * Renders html for the loaded content node.
+   *
+   *  <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 html of the loaded content node, or empty String if rendering fails or no content node is loaded
+   */
+  renderHtml(): string;
+};

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

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
+var _default = exports["default"] = {
+  update: function update() {},
+  updateByIdentifier: function updateByIdentifier() {},
+  updateByContentIdentifier: function updateByContentIdentifier() {},
+  isLoaded: function isLoaded() {},
+  renderHtml: function renderHtml() {}
+};

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

@@ -170,19 +170,40 @@ export type TextModuleRenderer = {
    * Updates the state of this renderer (potentially "loads" a Text module for rendering) using the identifier of a Text module Node.
    *
    *  <p>
+   *     The "identifier" is the JCR Node identifier (also the <code>jcr:uuid</code> property) of the Text module.
+   *  </p>
+   *  <p>
    *     <em>
    *        Note! If this state update fails (i.e. argument was null or not specifying a supported Text module that exists on the page
    *        this renderer was created for) there will be nothing to render. The state can always be checked via the
    *        {@link #isLoaded()} method.
    *     </em>
    *  </p>
-   * @param aTextModuleIdentifier the identifier of the Text module
+   * @param aTextModuleIdentifier the node identifier of the Text module
    */
   updateByIdentifier(aTextModuleIdentifier: String | string): void;
 
   /**
-   * Whether or not this renderer has been updated with a renderable text module.
-   * @return true if this renderer has a valid text module to render, false otherwise
+   * Updates the state of this renderer (potentially "loads" a Text module for rendering) using the content identifier that specifies a Text module.
+   *
+   *  <p>
+   *     The "content identifier" is the <code>contentIdentifier</code> property of the sv:portlet (i.e. a Text module).
+   *  </p>
+   *  <p>
+   *     <em>
+   *        Note! If this state update fails (i.e. argument was null or not specifying a supported Text module that exists on the page
+   *        this renderer was created for) there will be nothing to render. The state can always be checked via the
+   *        {@link #isLoaded()} method.
+   *     </em>
+   *  </p>
+   * @param aContentIdentifier the content identifier that specifies the Text module
+   * @since Sitevision 2026.01.1
+   */
+  updateByContentIdentifier(aContentIdentifier: String | string): void;
+
+  /**
+   * Whether this renderer has been updated with a renderable Text module.
+   * @return true if this renderer has a valid Text module to render, false otherwise
    */
   isLoaded(): boolean;
 

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

@@ -11,6 +11,7 @@ var _default = exports["default"] = {
   update: function update() {},
   updateByName: function updateByName() {},
   updateByIdentifier: function updateByIdentifier() {},
+  updateByContentIdentifier: function updateByContentIdentifier() {},
   isLoaded: function isLoaded() {},
   renderHtml: function renderHtml() {},
   renderText: function renderText() {},

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

@@ -146,7 +146,7 @@ export type VersionedRestApi = {
   ): unknown;
 
   /**
-   * Executes a PUT endpoint of the REST API
+   * Executes a PUT endpoint of the REST API, targeting an instance of the context.
    *
    *  <p>
    *  Delegates execution to {@link RestApi#put(javax.jcr.Node, String, javax.jcr.Node, Object) RestApi.put(Node,String,Node,Options)}

package/types/senselogic/sitevision/api/webresource/webcontent/TextModuleCreator/index.d.ts

@@ -0,0 +1,157 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
+import type { String } from "../../../../../../java/lang/String";
+import type { Node } from "../../../../../../javax/jcr/Node";
+import type ContentFormat from "../../../../../../../server/ContentFormat";
+
+/**
+ * Builder for creating new text modules (text portlets).
+ *
+ *  <p>
+ *  <strong>Required configuration:</strong>
+ *  </p>
+ *  <ul>
+ *    <li>Parent - the page, layout or portlet where the text module will be created</li>
+ *    <li>Content - the text content and its format</li>
+ *  </ul>
+ *
+ *  <p>
+ *     <strong>Optional configuration:</strong>
+ *  </p>
+ *  <ul>
+ *     <li>Name - the display name/title of the text module</li>
+ *  </ul>
+ *
+ *  <p>
+ *  <strong>Usage example:</strong>
+ *  </p>
+ *  <pre><code>
+ *     const factory = utils.getCreateContentFactory();
+ *
+ *     const creator = factory.getTextModuleCreator();
+ *     creator
+ *        .setName('Welcome Message')
+ *        .setParent(pageNode)
+ *        .setMarkdownContent('# Welcome\n\nThis is a **welcome** message.');
+ *
+ *     // Optionally check if configuration is valid before executing
+ *     if (creator.isValid()) {
+ *        const node = creator.execute();
+ *     }
+ *  </code></pre>
+ *
+ *  <p>
+ *  <strong>Permission requirements:</strong>
+ *  </p>
+ *  <p>
+ *  The current user must have permission to update the parent page. An exception will be
+ *  thrown during {@link #execute()} if the user lacks the necessary permissions.
+ *  </p>
+ *
+ *  <p>
+ *  An instance of the Sitevision class implementing this interface can be obtained via
+ *  {@link senselogic.sitevision.api.webresource.webcontent.CreateContentFactory#getTextModuleCreator()}.
+ *  See {@link senselogic.sitevision.api.webresource.webcontent.CreateContentFactory} for how to
+ *  obtain an instance of the <code>CreateContentFactory</code> interface.
+ *  </p>
+ * @author Jens Kalshoven
+ * @since Sitevision 2026.01.1
+ */
+export type TextModuleCreator = {
+  /**
+   * Sets the display name of the text module to be created.
+   *
+   *  <p>
+   *  The name is displayed as the portlet title and should be descriptive.
+   *  </p>
+   * @param aName The name of the text module
+   * @return This builder instance for method chaining
+   */
+  setName(aName: String | string): TextModuleCreator;
+
+  /**
+   * Sets the parent node where the text module will be created.
+   *
+   *  <p>
+   *  The parent can be either:
+   *  </p>
+   *  <ul>
+   *    <li>Page (e.g. sv:page, sv:article) - the text module will be appended to the first layout on the page</li>
+   *    <li>Layout (e.g. sv:layout) - the text module will be appended to the layout</li>
+   *    <li>Module (sv:portlet) - the text module will be inserted after the module</li>
+   *  </ul>
+   *
+   *  <p>
+   *  This is a required configuration parameter.
+   *  </p>
+   * @param aParent The parent node. Must be a valid page or content node
+   * @return This builder instance for method chaining
+   */
+  setParent(aParent: Node): TextModuleCreator;
+
+  /**
+   * Sets the content of the text module using Markdown format.
+   *
+   *  <p>
+   *  This is a convenience method equivalent to calling
+   *  {@code setContent(aMarkdownContent, ContentFormat.MARKDOWN)}.
+   *  The Markdown content will be parsed and converted to rich text elements.
+   *  </p>
+   *
+   *  <p>
+   *  See {@link ContentFormat#MARKDOWN} for details on supported syntax.
+   *  </p>
+   * @param aMarkdownContent The Markdown content. Must not be null or empty
+   * @return This builder instance for method chaining
+   */
+  setMarkdownContent(aMarkdownContent: String | string): TextModuleCreator;
+
+  /**
+   * Sets the content of the text module with an explicit format.
+   *
+   *  <p>
+   *  This method allows you to specify the content and its format explicitly.
+   *  The content will be parsed according to the specified format and converted
+   *  to rich text elements.
+   *  </p>
+   * @param aContent The text content. Must not be null or empty
+   * @param aContentFormat The format of the content. Must not be null
+   * @return This builder instance for method chaining
+   */
+  setContent(
+    aContent: String | string,
+    aContentFormat: ContentFormat
+  ): TextModuleCreator;
+
+  /**
+   * Best-attempt validation of the current builder configuration.
+   *
+   *  <p>
+   *  Checks if all required parameters are set and valid:
+   *  </p>
+   *  <ul>
+   *    <li>Parent is not null and is a valid page, layout or portlet</li>
+   *    <li>Content is not null and not empty</li>
+   *    <li>Content format is not null</li>
+   *    <li>The page is not trashed</li>
+   *    <li>The user has permission to update the page</li>
+   *  </ul>
+   * @return true if the configuration is valid, false otherwise
+   */
+  isValid(): boolean;
+
+  /**
+   * Creates the text module with the configured settings.
+   *
+   *  <p>
+   *  <strong>Important:</strong> This method modifies the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}
+   *  of the page content and saves the changes. The operation is performed under a lock to ensure consistency.
+   *  </p>
+   * @return The newly created sv:portlet node
+   * @throws IllegalStateException If the configuration is invalid
+   * @throws ConstraintViolationException If the parent is invalid, or the user lacks permission to update the page, or the page is trashed
+   * @throws RepositoryException If something else goes wrong
+   */
+  execute(): Node;
+};

package/types/senselogic/sitevision/api/webresource/webcontent/TextModuleCreator/index.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
+var _default = exports["default"] = {
+  setName: function setName() {},
+  setParent: function setParent() {},
+  setMarkdownContent: function setMarkdownContent() {},
+  setContent: function setContent() {},
+  isValid: function isValid() {},
+  execute: function execute() {}
+};