@sitevision/api 2025.10.1 → 2025.11.1

package/index.d.ts

@@ -37,6 +37,7 @@ import './server/FilterBuilder';
 import './server/FolderUtil';
 import './server/FontUtil';
 import './server/FormatterBuilderFactory';
+import './server/GeolocationValueBuilder';
 import './server/HighlightBuilder';
 import './server/IconUtil';
 import './server/ImageLinkRenderer';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2025.10.1",
+  "version": "2025.11.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -30,5 +30,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "2d9f0faf259b8bb67e61ecc370ce8775389bffec"
+  "gitHead": "197b8117f3063b9725e9c0329d24e3e9fb6172af"
 }

package/server/FileUtil/index.d.ts

@@ -131,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

@@ -12,6 +12,7 @@ var _default = exports["default"] = {
   createFile: function createFile() {},
   createFileFromBase64: function createFileFromBase64() {},
   createFileFromTemporary: function createFileFromTemporary() {},
+  copyFile: function copyFile() {},
   updateBinaryContent: function updateBinaryContent() {},
   updateBinaryContentFromBase64: function updateBinaryContentFromBase64() {},
   updateBinaryContentFromTemporary: function updateBinaryContentFromTemporary() {},

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

@@ -158,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

@@ -12,6 +12,7 @@ var _default = exports["default"] = {
   createImage: function createImage() {},
   createImageFromBase64: function createImageFromBase64() {},
   createImageFromTemporary: function createImageFromTemporary() {},
+  copyImage: function copyImage() {},
   updateBinaryContent: function updateBinaryContent() {},
   updateBinaryContentFromBase64: function updateBinaryContentFromBase64() {},
   updateBinaryContentFromTemporary: function updateBinaryContentFromTemporary() {},

package/server/LinkValueBuilder/index.d.ts

@@ -8,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/MetadataUtil/index.d.ts

@@ -10,6 +10,7 @@ import type { String } from "../../types/java/lang/String";
 import type { List } from "../../types/java/util/List";
 import type { LinkValueBuilder } from "../LinkValueBuilder";
 import type { RelatedValueBuilder } from "../RelatedValueBuilder";
+import type { GeolocationValueBuilder } from "../GeolocationValueBuilder";
 
 /**
  * <p>
@@ -140,6 +141,11 @@ export interface MetadataUtil {
    *      a comma separated string of the tag names. Note that tag names provided as a comma separated string must be prefixed with #.
    *      It is also possible to provide a collection or an array of <code>sv:tag</code> or strings of tag names.
    *   </li>
+   *   <li>
+   *      <strong>geolocation</strong> <em>(since Sitevision 2025.11.1)</em><br>
+   *      The value must be a {@link senselogic.sitevision.api.metadata.value.GeolocationValue}.
+   *      If no valid value is provided an <code>UnsupportedOperationException</code> is thrown.
+   *   </li>
    *  </ul>
    *
    *  <p>
@@ -332,7 +338,7 @@ export interface MetadataUtil {
 
   /**
    * <p>
-   *     Returns a link value builder that can be used to build <code>LinkValue</code> instances.
+   *     Returns a link value builder that creates {@link senselogic.sitevision.api.metadata.value.LinkValue} instances.
    *  </p>
    *
    *  <p>
@@ -347,7 +353,7 @@ export interface MetadataUtil {
 
   /**
    * <p>
-   *     Returns a related value builder that can be used to build <code>RelatedValue</code> instances.
+   *     Returns a related value builder that creates {@link senselogic.sitevision.api.metadata.value.RelatedValue} instances.
    *  </p>
    *
    *  <p>
@@ -359,6 +365,21 @@ export interface MetadataUtil {
    * @since Sitevision 3.6
    */
   getRelatedValueBuilder(): RelatedValueBuilder;
+
+  /**
+   * <p>
+   *     Returns a geolocation value builder that creates {@link senselogic.sitevision.api.metadata.value.GeolocationValue} instances.
+   *  </p>
+   *
+   *  <p>
+   *     <strong>Tip!</strong> A <code>GeolocationValue</code> can be used to set a <em>geolocation metadata</em>
+   *     via {@link #setMetadataPropertyValue(javax.jcr.Node, String, Object)}
+   *     or {@link #setMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property, Object)}.
+   *  </p>
+   * @return a geolocation value builder
+   * @since Sitevision 2025.11.1
+   */
+  getGeolocationValueBuilder(): GeolocationValueBuilder;
 }
 
 declare namespace MetadataUtil {}

package/server/MetadataUtil/index.js

@@ -14,5 +14,6 @@ var _default = exports["default"] = {
   getRelatedMetadataPropertyValues: function getRelatedMetadataPropertyValues() {},
   getLinkMetadataPropertyValue: function getLinkMetadataPropertyValue() {},
   getLinkValueBuilder: function getLinkValueBuilder() {},
-  getRelatedValueBuilder: function getRelatedValueBuilder() {}
+  getRelatedValueBuilder: function getRelatedValueBuilder() {},
+  getGeolocationValueBuilder: function getGeolocationValueBuilder() {}
 };

package/server/RelatedValueBuilder/index.d.ts

@@ -8,7 +8,7 @@ import type { RelatedValue } from "../../types/senselogic/sitevision/api/metadat
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
 /**
- * Builder to create RelatedValue instances that can be used to set related metadata.
+ * Builder to create {@link RelatedValue} instances that can be used to set related metadata.
  *
  *  <p>
  *     RelatedValueBuilder has one <strong>mandatory attribute</strong>:

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/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)}