@sitevision/api 2025.9.2 → 2025.11.1

package/server/EndecUtil/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   escapeXML: function escapeXML() {},
   unEscapeXML: function unEscapeXML() {},

package/server/ExtendedDismaxParserBuilder/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { String } from "../../types/java/lang/String";
 
 import type { Parser } from "../../types/senselogic/sitevision/api/search/searcher/component/Parser";

package/server/ExtendedDismaxParserBuilder/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   addQueryField: function addQueryField() {},
   clearQueryFields: function clearQueryFields() {},

package/server/FileIconRenderer/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { Locale } from "../../types/java/util/Locale";
 
 import type { String } from "../../types/java/lang/String";

package/server/FileIconRenderer/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   setLocale: function setLocale() {},
   setUseSmallIcons: function setUseSmallIcons() {},

package/server/FileUtil/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { Node } from "../../types/javax/jcr/Node";
 import type { Map } from "../../types/java/util/Map";
 
@@ -128,6 +131,29 @@ export interface FileUtil {
    */
   createFileFromTemporary(aParent: Node, aTemporaryFile: Node): Node;
 
+  /**
+  * Copies a file to a given parent.
+  *
+  * <p>
+  *    Note that the <code>aParent</code> of the file must be a <code>sv:localFileRepository</code>, <code>sv:fileRepository</code>,
+  *    <code>sv:personalFileRepository</code> or a <code>sv:folder</code> residing as sub node to a file repository.
+  *    The <code>aParent</code> must not be trashed.
+  * </p>
+  * <p>
+  *    <strong>Permission note!</strong> Current user must be authorized to alter the parent node
+  *    (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+  * </p>
+  *
+  * @param aFile the file node to copy
+  * @param aParent the parent node where the file should be copied to
+  * @return a file node corresponding to the newly created file
+  * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid
+  *                                      parent node is specified, if an invalid file node is specified
+  * @throws RepositoryException          if something else goes wrong
+  * @since Sitevision 2026.01.1
+  */
+  copyFile(aFile: Node, aParent: Node): Node;
+
   /**
    * Updates the binary content of an existing file using a uri string.
    *

package/server/FileUtil/index.js

@@ -4,11 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   createFiles: function createFiles() {},
   createFile: function createFile() {},
   createFileFromBase64: function createFileFromBase64() {},
   createFileFromTemporary: function createFileFromTemporary() {},
+  copyFile: function copyFile() {},
   updateBinaryContent: function updateBinaryContent() {},
   updateBinaryContentFromBase64: function updateBinaryContentFromBase64() {},
   updateBinaryContentFromTemporary: function updateBinaryContentFromTemporary() {},

package/server/FilterBuilder/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { String } from "../../types/java/lang/String";
 import type { Filter } from "../../types/senselogic/sitevision/api/search/searcher/component/Filter";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";

package/server/FilterBuilder/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   addFilterQuery: function addFilterQuery() {},
   clearFilterQueries: function clearFilterQueries() {},

package/server/FolderUtil/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { Node } from "../../types/javax/jcr/Node";
 import type { String } from "../../types/java/lang/String";
 

package/server/FolderUtil/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   createFolder: function createFolder() {},
   renameFolder: function renameFolder() {},

package/server/FontUtil/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { String } from "../../types/java/lang/String";
 import type { Node } from "../../types/javax/jcr/Node";
 

package/server/FontUtil/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   getFontByName: function getFontByName() {},
   getFontByClassName: function getFontByClassName() {}

package/server/FormatterBuilderFactory/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { Locale } from "../../types/java/util/Locale";
 import type { NumericFormatterBuilder } from "../../types/senselogic/sitevision/api/format/NumericFormatterBuilder";
 import type { Currency } from "../../types/senselogic/sitevision/api/i18n/Currency";

package/server/FormatterBuilderFactory/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   getNumberFormatterBuilder: function getNumberFormatterBuilder() {},
   getPercentFormatterBuilder: function getPercentFormatterBuilder() {},

package/server/GeolocationValueBuilder/index.d.ts

@@ -0,0 +1,95 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
+import type { String } from "../../types/java/lang/String";
+
+import type { GeolocationValue } from "../../types/senselogic/sitevision/api/metadata/value/GeolocationValue";
+import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
+
+/**
+ * Builder to create {@link GeolocationValue} instances that can be used to set geolocation metadata.
+ *
+ *  <p>
+ *     GeolocationValueBuilder has three <strong>mandatory attributes</strong>:
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        <em>name</em> - The location name. Must not be null or blank.
+ *     </li>
+ *     <li>
+ *        <em>latitude</em> - The Latitude. Must be a double value within range <code>[-90.0 ... 90.0]</code>.
+ *     </li>
+ *     <li>
+ *        <em>longitude</em> - The Longitude. Must be a double value within range <code>[-180.0 ... 180.0]</code>.
+ *     </li>
+ *  </ul>
+ *  <p>
+ *     Using the GeolocationValueBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
+ *     would typically use it like this:
+ *  </p>
+ *  <ol>
+ *    <li>Get the GeolocationValueBuilder</li>
+ *    <li>Set the name</li>
+ *    <li>Set the latitude</li>
+ *    <li>Set the longitude</li>
+ *    <li>Do build</li>
+ *  </ol>
+ *  <p>
+ *     When you have built a <code>GeolocationValue</code> instance, you can re-use the GeolocationValueBuilder to build more instances.
+ *     Something like:
+ *  </p>
+ *  <ol>
+ *    <li>Possibly set a new name</li>
+ *    <li>Possibly set a new latitude</li>
+ *    <li>Possibly set a new longitude</li>
+ *    <li>Do build</li>
+ *  </ol>
+ *
+ *  <p>
+ *     <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
+ *     more information about Builders and how to work with them!
+ *  </p>
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.metadata.MetadataUtil#getGeolocationValueBuilder()}.
+ *     See {@link senselogic.sitevision.api.metadata.MetadataUtil} for how to obtain an instance of the <code>MetadataUtil</code> interface.
+ *  </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 2025.11.1
+ */
+export interface GeolocationValueBuilder extends Builder {
+  /**
+   * Sets the location name.
+   * @param aLocationName the location name, must not be null or blank
+   * @return this builder
+   */
+  setName(aLocationName: String | string): GeolocationValueBuilder;
+
+  /**
+   * Sets the latitude.
+   * @param aLatitude the latitude, must be within range [-90.0 ... 90.0]
+   * @return this builder
+   */
+  setLatitude(aLatitude: number): GeolocationValueBuilder;
+
+  /**
+   * Sets the longitude.
+   * @param aLongitude the longitude, must be within range [-180.0 ... 180.0]
+   * @return this builder
+   */
+  setLongitude(aLongitude: number): GeolocationValueBuilder;
+
+  /**
+   * Creates a GeolocationValue instance using current state of this builder.
+   * @return a geolocation value
+   * @throws IllegalStateException if the name, longitude or latitude value are invalid
+   */
+  build(): GeolocationValue;
+}
+
+declare namespace GeolocationValueBuilder {}
+
+declare var geolocationValueBuilder: GeolocationValueBuilder;
+
+export default geolocationValueBuilder;

package/server/GeolocationValueBuilder/index.js

@@ -0,0 +1,15 @@
+"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() {},
+  setLatitude: function setLatitude() {},
+  setLongitude: function setLongitude() {},
+  build: function build() {}
+};

package/server/HighlightBuilder/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { String } from "../../types/java/lang/String";
 
 import type { Highlight } from "../../types/senselogic/sitevision/api/search/searcher/component/Highlight";

package/server/HighlightBuilder/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   addHighlightedField: function addHighlightedField() {},
   clearHighlightedFields: function clearHighlightedFields() {},

package/server/IconUtil/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { String } from "../../types/java/lang/String";
 import type { Node } from "../../types/javax/jcr/Node";
 

package/server/IconUtil/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   getFileIcons: function getFileIcons() {},
   getSmallFileIconURI: function getSmallFileIconURI() {},

package/server/ImageLinkRenderer/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { LinkRenderer } from "../LinkRenderer";
 import type { ImageRenderer } from "../ImageRenderer";
 import type { String } from "../../types/java/lang/String";

package/server/ImageLinkRenderer/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   getLinkRenderer: function getLinkRenderer() {},
   getImageRenderer: function getImageRenderer() {},

package/server/ImageRenderer/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { ImageScaler } from "../../types/senselogic/sitevision/api/render/ImageScaler";
 
 import type { Node } from "../../types/javax/jcr/Node";

package/server/ImageRenderer/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   setImageScaler: function setImageScaler() {},
   clearImageScaler: function clearImageScaler() {},

package/server/ImageUtil/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { Node } from "../../types/javax/jcr/Node";
 import type { Map } from "../../types/java/util/Map";
 
@@ -155,6 +158,29 @@ export interface ImageUtil {
    */
   createImageFromTemporary(aParent: Node, aTemporaryFile: Node): Node;
 
+  /**
+  * Copies an image to a given parent.
+  *
+  * <p>
+  *    Note that the <code>aParent</code> for the image must be a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>,
+  *    <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
+  *    The <code>aParent</code> must not be trashed.
+  * </p>
+  * <p>
+  *    <strong>Permission note!</strong> Current user must be authorized to alter the parent node
+  *    (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+  * </p>
+  *
+  * @param aImage the image node to copy
+  * @param aParent the parent node where the image should be copied to
+  * @return an image node corresponding to the newly created image
+  * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid
+  *                                      parent node is specified, if an invalid image node is specified
+  * @throws RepositoryException          if something else goes wrong
+  * @since Sitevision 2026.01.1
+  */
+  copyImage(aImage: Node, aParent: Node): Node;
+
   /**
    * Updates the binary content of an existing image using a uri string.
    *

package/server/ImageUtil/index.js

@@ -4,11 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   createImages: function createImages() {},
   createImage: function createImage() {},
   createImageFromBase64: function createImageFromBase64() {},
   createImageFromTemporary: function createImageFromTemporary() {},
+  copyImage: function copyImage() {},
   updateBinaryContent: function updateBinaryContent() {},
   updateBinaryContentFromBase64: function updateBinaryContentFromBase64() {},
   updateBinaryContentFromTemporary: function updateBinaryContentFromTemporary() {},

package/server/IndexUtil/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type IndexType from "../IndexUtil.IndexType";
 import type { Node } from "../../types/javax/jcr/Node";
 import type { String } from "../../types/java/lang/String";

package/server/IndexUtil/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   getDefaultIndex: function getDefaultIndex() {},
   getIndexByName: function getIndexByName() {}

package/server/IndexUtil.IndexType/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
+
 /**
  * Type of default index, used by {@link senselogic.sitevision.api.search.index.IndexUtil}.
  *

package/server/IndexUtil.IndexType/index.js

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

package/server/IndexingUtil/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { Node } from "../../types/javax/jcr/Node";
 
 import type { IndexingUtilConstants } from "../../types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants";

package/server/IndexingUtil/index.js

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

package/server/InstanceCreatorUtil/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { String } from "../../types/java/lang/String";
 import type { Object } from "../../types/java/lang/Object";
 import type { TypedArgument } from "../../types/senselogic/sitevision/api/script/factory/TypedArgument";

package/server/InstanceCreatorUtil/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   getDefaultInstance: function getDefaultInstance() {},
   getArgumentInstance: function getArgumentInstance() {},

package/server/InstanceTypeUtil/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { Object } from "../../types/java/lang/Object";
 
 /**

package/server/InstanceTypeUtil/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   isString: function isString() {},
   isBoolean: function isBoolean() {},

package/server/JwtUtil/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
+
 import type { String } from "../../types/java/lang/String";
 import type { Node } from "../../types/javax/jcr/Node";
 

package/server/JwtUtil/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   createSHAToken: function createSHAToken() {},
   createRSAToken: function createRSAToken() {},

package/server/LandingPageUtil/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { Node } from "../../types/javax/jcr/Node";
 
 /**

package/server/LandingPageUtil/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   getErrorPage: function getErrorPage() {},
   getLoginPage: function getLoginPage() {},

package/server/LinkPageUtil/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { Node } from "../../types/javax/jcr/Node";
 import type { String } from "../../types/java/lang/String";
 import type { LinkTarget } from "../../types/senselogic/sitevision/api/webresource/LinkTarget";

package/server/LinkPageUtil/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   createLinkPage: function createLinkPage() {},
   renameLinkPage: function renameLinkPage() {},

package/server/LinkRenderer/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { Node } from "../../types/javax/jcr/Node";
 import type { String } from "../../types/java/lang/String";
 

package/server/LinkRenderer/index.js

@@ -4,6 +4,9 @@ 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() {},
   updateClean: function updateClean() {},

package/server/LinkTargetBuilder/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { Node } from "../../types/javax/jcr/Node";
 import type { String } from "../../types/java/lang/String";
 

package/server/LinkTargetBuilder/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   setInternalTarget: function setInternalTarget() {},
   setExternalTarget: function setExternalTarget() {},

package/server/LinkValueBuilder/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * This file is auto generated from JavaDoc. Do not modify it manually.
+ */
 import type { String } from "../../types/java/lang/String";
 import type { Node } from "../../types/javax/jcr/Node";
 
@@ -5,7 +8,7 @@ import type { LinkValue } from "../../types/senselogic/sitevision/api/metadata/v
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
 /**
- * Builder to create LinkValue instances that can be used to set link metadata.
+ * Builder to create {@link LinkValue} instances that can be used to set link metadata.
  *
  *  <p>
  *     LinkValueBuilder has one <strong>mandatory attribute</strong>:

package/server/LinkValueBuilder/index.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * This file is auto generated. Do not modify it manually.
+ */
 var _default = exports["default"] = {
   setExternalTarget: function setExternalTarget() {},
   setMailTarget: function setMailTarget() {},