@sitevision/api 2024.7.1 → 2024.8.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2024.7.1",
+  "version": "2024.8.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -30,5 +30,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "fcd74122108f19e03a0a9db51efc16286fc7a802"
+  "gitHead": "b1cf021d20a7d375727046c8316c02859138bdf7"
 }

package/server/ImageUtil/index.d.ts

@@ -281,7 +281,7 @@ export interface ImageUtil {
    * @param aAltText the alt text to set
    * @throws ConstraintViolationException if aImage is not a sv:image or if current user is not authorized to alter the image node
    * @throws RepositoryException if something else goes wrong
-   * @since Sitevision 2024.06.1
+   * @since Sitevision 2024.07.1
    */
   setAltText(aImage: Node, aAltText: String | string): void;
 
@@ -299,7 +299,7 @@ export interface ImageUtil {
    * @param aCaptionText the caption text to set
    * @throws ConstraintViolationException if aImage is not a sv:image or if current user is not authorized to alter the image node
    * @throws RepositoryException if something else goes wrong
-   * @since Sitevision 2024.06.1
+   * @since Sitevision 2024.07.1
    */
   setCaptionText(aImage: Node, aCaptionText: String | string): void;
 }

package/server/LinkRenderer/index.d.ts

@@ -83,6 +83,10 @@ import type { String } from "../../types/java/lang/String";
  *        Default is no data attributes
  *      </li>
  *      <li style="margin-top:5px">
+ *        <em>ariaAttributes</em> - Additional HTML5 aria-* attributes.<br>
+ *        Default is no aria attributes
+ *      </li>
+ *      <li style="margin-top:5px">
  *        <em>download</em> - Whether or not to add the HTML5-specific <em>download</em> attribute
  *        (indication to the browser to download the link target instead of navigating to it).<br>
  *        Default is <code>false</code>
@@ -347,6 +351,7 @@ export interface LinkRenderer {
    *    <li><code>clearAccessKey()</code></li>
    *    <li><code>clearOpenNewWindow()</code></li>
    *    <li><code>clearDataAttributes()</code></li>
+   *    <li><code>clearAriaAttributes()</code></li>
    *    <li><code>clearUseDownload()</code></li>
    *    <li><code>clearLang()</code></li>
    *    <li><code>clearHrefLang()</code></li>
@@ -359,6 +364,7 @@ export interface LinkRenderer {
    * @see #clearAccessKey()
    * @see #clearOpenNewWindow()
    * @see #clearDataAttributes()
+   * @see #clearAriaAttributes()
    * @see #clearUseDownload()
    * @see #clearLang()
    * @see #clearHrefLang()
@@ -636,7 +642,7 @@ export interface LinkRenderer {
   clearUseParameterEncoding(): void;
 
   /**
-   * Adds an HTML5 data-* attribute to the link element.
+   * Adds a data-* attribute to the link element.
    *  Data attributes is optional when the result is rendered. Default is no data attributes.
    *  <p>
    *     There can only be one data attribute per name (i.e. when a data attribute is added it will always replace the possibly existing
@@ -648,7 +654,7 @@ export interface LinkRenderer {
    *  </p>
    *  <ul>
    *     <li>
-   *        A <strong>name</strong> that is <code>null</code> or <em>whitespace-only</em> will be completely ignored,
+   *        A <strong>name</strong> that is <code>null</code>, <em>whitespace-only</em> or <em>prefix-only</em> will be completely ignored,
    *        i.e. no data attribute will be rendered.
    *     </li>
    *     <li>
@@ -668,11 +674,50 @@ export interface LinkRenderer {
   addDataAttribute(aName: String | string, aValue: String | string): void;
 
   /**
-   * Removes all existing data attributes
+   * Removes all existing data attributes.
    * @since Sitevision 3.0
    */
   clearDataAttributes(): void;
 
+  /**
+   * Adds an aria-* attribute to the link element.
+   *  Aria attributes are optional when the result is rendered. Default is no aria attributes.
+   *  <p>
+   *     There can only be one aria attribute per name (i.e. when an aria attribute is added it will always replace the possibly existing
+   *     aria attribute that already use that name).
+   *  </p>
+   *
+   *  <p>
+   *     Notes about names and values:
+   *  </p>
+   *  <ul>
+   *     <li>
+   *        A <strong>name</strong> that is <code>null</code>, <em>whitespace-only</em> or <em>prefix-only</em> will be completely ignored,
+   *        i.e. no aria attribute will be rendered.
+   *     </li>
+   *     <li>
+   *        A <strong>name</strong> that isn't properly prefixed with <em>"aria-"</em> will be prefixed when the aria attribute is rendered.
+   *     </li>
+   *     <li>
+   *        A <strong>value</strong> that is <code>null</code> or <em>whitespace-only</em> will be rendered as an aria attribute without value.
+   *     </li>
+   *     <li>
+   *        A <strong>value</strong> should not be escaped/encoded. The <em>useEncoding</em> attribute will determine what to do
+   *        when the aria attributes are rendered.
+   *     </li>
+   *  </ul>
+   * @param aName the name of the aria attribute
+   * @param aValue the value of the aria attribute
+   * @since Sitevision 2024.08.1
+   */
+  addAriaAttribute(aName: String | string, aValue: String | string): void;
+
+  /**
+   * Removes all existing aria attributes.
+   * @since Sitevision 2024.08.1
+   */
+  clearAriaAttributes(): void;
+
   /**
    * Sets what access key the link should have (accesskey attribute on the a element)
    *  The accesskey attribute is optional when the result is rendered. Default is <code>null</code>.

package/server/LinkRenderer/index.js

@@ -31,6 +31,8 @@ var _default = {
   clearUseParameterEncoding: function clearUseParameterEncoding() {},
   addDataAttribute: function addDataAttribute() {},
   clearDataAttributes: function clearDataAttributes() {},
+  addAriaAttribute: function addAriaAttribute() {},
+  clearAriaAttributes: function clearAriaAttributes() {},
   setAccessKey: function setAccessKey() {},
   clearAccessKey: function clearAccessKey() {},
   setRel: function setRel() {},

package/server/NodeTypeUtil/index.d.ts

@@ -126,6 +126,18 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
     */
   LINK_TYPE: "sv:link";
 
+  /**
+   * The primary node type name for a LLM configuration.
+   * @since Sitevision 2024.08.1
+   */
+  LLM_CONFIGURATION_TYPE: "sv:llmConfiguration";
+
+  /**
+   * The primary node type name for a LLM configuration repository.
+   * @since Sitevision 2024.08.1
+   */
+  LLM_CONFIGURATION_REPOSITORY_TYPE: "sv:llmConfigurationRepository";
+
   /**
    * The primary node type name for a node index.
    * @since Sitevision 3.6

package/server/ResourceLocatorUtil/index.d.ts

@@ -474,6 +474,13 @@ export interface ResourceLocatorUtil {
    * @since Sitevision 2024.04.2
    */
   getCssRuleRepository(): Node;
+
+  /**
+   * Gets the LLM configuration repository (sv:llmConfigurationRepository) for the site of current node.
+   * @return the LLM configuration repository, or null if indeterminable.
+   * @since Sitevision 2024.08.1
+   */
+  getLlmConfigurationRepository(): Node;
 }
 
 declare namespace ResourceLocatorUtil {}

package/server/ResourceLocatorUtil/index.js

@@ -49,6 +49,7 @@ var _default = {
   getSiteCookieRepository: function getSiteCookieRepository() {},
   getImageFilterRepository: function getImageFilterRepository() {},
   getWorkStatusTemplateRepository: function getWorkStatusTemplateRepository() {},
-  getCssRuleRepository: function getCssRuleRepository() {}
+  getCssRuleRepository: function getCssRuleRepository() {},
+  getLlmConfigurationRepository: function getLlmConfigurationRepository() {}
 };
 exports["default"] = _default;

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

@@ -114,6 +114,20 @@ export type NodeTypeUtilConstants = {
    */
   getLINK_TYPE(): string;
 
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#LLM_CONFIGURATION_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#LLM_CONFIGURATION_TYPE}
+   * @since Sitevision 2024.08.1
+   */
+  getLLM_CONFIGURATION_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#LLM_CONFIGURATION_REPOSITORY_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#LLM_CONFIGURATION_REPOSITORY_TYPE}
+   * @since Sitevision 2024.08.1
+   */
+  getLLM_CONFIGURATION_REPOSITORY_TYPE(): string;
+
   /**
    * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#NODE_INDEX_TYPE}.
    * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#NODE_INDEX_TYPE}

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

@@ -22,6 +22,8 @@ var _default = {
   getLAYOUT_TYPE: function getLAYOUT_TYPE() {},
   getLINKED_LAYOUT_TYPE: function getLINKED_LAYOUT_TYPE() {},
   getLINK_TYPE: function getLINK_TYPE() {},
+  getLLM_CONFIGURATION_TYPE: function getLLM_CONFIGURATION_TYPE() {},
+  getLLM_CONFIGURATION_REPOSITORY_TYPE: function getLLM_CONFIGURATION_REPOSITORY_TYPE() {},
   getNODE_INDEX_TYPE: function getNODE_INDEX_TYPE() {},
   getPAGE_TYPE: function getPAGE_TYPE() {},
   getPORTLET_TYPE: function getPORTLET_TYPE() {},