@sitevision/api 1.1.0-alpha.2 → 2.0.0-alpha.0

package/hidden/senselogic/sitevision/api/webresource/builder/LinkTargetBuilder/index.d.ts

@@ -0,0 +1,128 @@
+import Node from "../../../../../../javax/jcr/Node";
+
+import LinkTarget from "../../LinkTarget";
+import Builder from "../../../base/Builder";
+
+/**
+ * Builder to create link target instances that can be used to create and update a Link page
+ * via {@link senselogic.sitevision.api.webresource.LinkPageUtil}.
+ *
+ * <p>
+ *    LinkTargetBuilder has one <strong>mandatory attribute</strong>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       <em>target</em> - The target. Must be non-null.
+ *    </li>
+ * </ul>
+ * <p>
+ *    LinkTargetBuilder also has some <strong>optional attributes</strong>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       <em>description</em> - The description. Default is <code>null</code>.
+ *    </li>
+ *    <li>
+ *       <em>open in new window</em> - Whether or not the target should be opened in new window. Default is <code>false</code>.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    Using the LinkTargetBuilder 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 LinkTargetBuilder</li>
+ *   <li>Set the target</li>
+ *   <li>Possibly set a description</li>
+ *   <li>Possibly set open in new window</li>
+ *   <li>Do build</li>
+ * </ol>
+ * <p>
+ *    When you have built a <code>LinkTarget</code> instance, you can re-use the LinkTargetBuilder to build more instances. Something like:
+ * </p>
+ * <ol>
+ *   <li>Set a new target</li>
+ *   <li>Possibly set a description</li>
+ *   <li>Possibly set open in new window</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.webresource.WebResourceFactory#getLinkTargetBuilder()}.
+ *    See {@link senselogic.sitevision.api.webresource.WebResourceFactory} for how to obtain an instance of the
+ *    <code>WebResourceFactory</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 4.2
+ * @see senselogic.sitevision.api.webresource.LinkPageUtil
+ */
+
+interface LinkTargetBuilder {
+  /**
+   * Sets the target.
+   * @param aNode the target, must be a linkable resource (i.e. a page/article/image/file or such) that isn't trashed.
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or not a linkable resource.
+   */
+  setInternalTarget(aNode: Node): LinkTargetBuilder;
+
+  /**
+   * Sets the target.
+   * @param aURL the link target URL
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aURL</code> is <code>null</code> or whitespace only
+   */
+  setExternalTarget(aURL: java.lang.String): LinkTargetBuilder;
+
+  /**
+   * Sets the target.
+   * @param aMailAddress a mail address
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aMailAddress</code> is <code>null</code>, whitespace only or an invalid mail address.
+   * @see senselogic.sitevision.api.mail.MailUtil#isValidAddress(String)
+   */
+  setMailTarget(aMailAddress: java.lang.String): LinkTargetBuilder;
+
+  /**
+   * Sets the target.
+   * @param aPhoneNumber a phone number
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aPhoneNumber</code> is <code>null</code>, whitespace only or an invalid phone number.
+   */
+  setPhoneTarget(aPhoneNumber: java.lang.String): LinkTargetBuilder;
+
+  /**
+   * Sets the description.
+   * @param aDescription the description
+   * @return this builder
+   */
+  setDescription(aDescription: java.lang.String): LinkTargetBuilder;
+
+  /**
+   * Sets open in new window.
+   * @param aOpenInNewWindow whether or not the target should be opened in new window
+   * @return this builder
+   */
+  setOpenInNewWindow(aOpenInNewWindow: boolean): LinkTargetBuilder;
+
+  /**
+   * Creates a LinkTarget instance using current state of this builder.
+   *
+   * <p>
+   *    <em>
+   *       Note! The 'open in new window' state is ignored when creating a LinkTarget with
+   *       a mail or telephone target (these target types can never be opened in a new window).
+   *    </em>
+   * </p>
+   * @return a link target
+   * @throws IllegalStateException if there are no link target.
+   */
+  build(): LinkTarget;
+}

package/hidden/senselogic/sitevision/api/webresource/doctype/DocTypeUtil/index.d.ts

@@ -0,0 +1,141 @@
+import Node from "../../../../../../javax/jcr/Node";
+
+/**
+ * A utility interface for checking what DOCTYPE a page uses.
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDocTypeUtil()}.
+ * 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 3.0
+ */
+
+interface DocTypeUtil {
+  /**
+   * Checks if the doctype for current page is HTML 4.01 Transitional or HTML5.
+   * @return <code>true</code> if current page is HTML 4.01 Transitional or HTML5, <code>false</code> otherwise
+   * @see DocType#HTML4_TRANSITIONAL
+   * @see DocType#HTML5
+   */
+  isHtml(): boolean;
+
+  /**
+   * Checks if the doctype for a certain page is HTML 4.01 Transitional or HTML5.
+   * @param aPageNode the page tree node to check
+   * @return <code>true</code> if <code>aPageNode</code> is HTML 4.01 Transitional or HTML5, <code>false</code> otherwise
+   * @see DocType#HTML4_TRANSITIONAL
+   * @see DocType#HTML5
+   */
+  isHtml(aPageNode: Node): boolean;
+
+  /**
+   * Checks if the doctype for current page is HTML 4.01 Transitional.
+   * @return <code>true</code> if current page is HTML 4.01 Transitional, <code>false</code> otherwise
+   * @see DocType#HTML4_TRANSITIONAL
+   */
+  isHtml4(): boolean;
+
+  /**
+   * Checks if the doctype for a certain page is HTML 4.01 Transitional.
+   * @param aPageNode the page tree node to check
+   * @return <code>true</code> if <code>aPageNode</code> is HTML 4.01 Transitional, <code>false</code> otherwise
+   * @see DocType#HTML4_TRANSITIONAL
+   */
+  isHtml4(aPageNode: Node): boolean;
+
+  /**
+   * Checks if the doctype for current page is HTML5.
+   * @return <code>true</code> if current page is HTML5, <code>false</code> otherwise
+   * @see DocType#HTML5
+   */
+  isHtml5(): boolean;
+
+  /**
+   * Checks if the doctype for a certain page is HTML5.
+   * @param aPageNode the page tree node to check
+   * @return <code>true</code> if <code>aPageNode</code> is HTML5, <code>false</code> otherwise
+   * @see DocType#HTML5
+   */
+  isHtml5(aPageNode: Node): boolean;
+
+  /**
+   * Checks if the doctype for current page is XHTML 1.0 Transitional or XHTML 1.0 Strict.
+   * @return <code>true</code> if current page is XHTML 1.0 Transitional or XHTML 1.0 Strict, <code>false</code> otherwise
+   * @see DocType#XHTML1_TRANSITIONAL
+   * @see DocType#XHTML1_STRICT
+   */
+  isXhtml(): boolean;
+
+  /**
+   * Checks if the doctype for a certain page is XHTML 1.0 Transitional or XHTML 1.0 Strict.
+   * @param aPageNode the page tree node to check
+   * @return <code>true</code> if <code>aPageNode</code> is XHTML 1.0 Transitional or XHTML 1.0 Strict, <code>false</code> otherwise
+   * @see DocType#XHTML1_TRANSITIONAL
+   * @see DocType#XHTML1_STRICT
+   */
+  isXhtml(aPageNode: Node): boolean;
+
+  /**
+   * Checks if the doctype for current page is XHTML 1.0 Transitional.
+   * @return <code>true</code> if current page is XHTML 1.0 Transitional, <code>false</code> otherwise
+   * @see DocType#XHTML1_TRANSITIONAL
+   */
+  isXhtmlTransitional(): boolean;
+
+  /**
+   * Checks if the doctype for a certain page is XHTML 1.0 Transitional.
+   * @param aPageNode the page tree node to check
+   * @return <code>true</code> if <code>aPageNode</code> is XHTML 1.0 Transitional, <code>false</code> otherwise
+   * @see DocType#XHTML1_TRANSITIONAL
+   */
+  isXhtmlTransitional(aPageNode: Node): boolean;
+
+  /**
+   * Checks if the doctype for current page is XHTML 1.0 Strict.
+   * @return <code>true</code> if current page is XHTML 1.0 Strict, <code>false</code> otherwise
+   * @see DocType#XHTML1_STRICT
+   */
+  isXhtmlStrict(): boolean;
+
+  /**
+   * Checks if the doctype for a certain page is XHTML 1.0 Strict.
+   * @param aPageNode the page tree node to check
+   * @return <code>true</code> if <code>aPageNode</code> is XHTML 1.0 Strict, <code>false</code> otherwise
+   * @see DocType#XHTML1_STRICT
+   */
+  isXhtmlStrict(aPageNode: Node): boolean;
+
+  /**
+   * Gets the doctype for current page.
+   * @return the doctype for current page
+   */
+  getDocType(): DocType;
+
+  /**
+   * Gets the doctype for a certain page.
+   * @param aPageNode the page tree node to get doctype for
+   * @return the doctype for <code>aPageNode</code>
+   */
+  getDocType(aPageNode: Node): DocType;
+
+  /**
+   * Checks if the doctype for current page matches a certain DocType.
+   * @param aDocType the doctype to check against
+   * @return <code>true</code> if the doctype for current page matches <code>aDocType</code>, <code>false</code> otherwise
+   */
+  isDocType(
+    aDocType: senselogic.sitevision.api.webresource.doctype.DocType
+  ): boolean;
+
+  /**
+   * Checks if the doctype for a certain page matches a certain DocType.
+   * @param aPageNode the page tree node to check
+   * @param aDocType the doctype to check against
+   * @return <code>true</code> if the doctype for <code>aPageNode</code> matches <code>aDocType</code>, <code>false</code> otherwise
+   */
+  isDocType(
+    aPageNode: Node,
+    aDocType: senselogic.sitevision.api.webresource.doctype.DocType
+  ): boolean;
+}

package/hidden/senselogic/sitevision/api/webresource/mime/MimeTypeUtil/index.d.ts

@@ -0,0 +1,217 @@
+/**
+ * A utility that determines an appropriate MIME type for a file extension or vice versa.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getMimeTypeUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>The generic <code>application/octet-stream</code> MIME type.
+ *
+ * <p><em>Would typically be appropriate to use as value for the fallback MIME type when using the
+ * {@link #getMimeType(String, String)} whenever you require an acceptable, non-null MIME type to be returned.</em></p>
+ * <pre><code>    String mime = aMimeTypeUtil.getMimeType(anExtension, MimeTypeUtil.GENERIC_MIME_TYPE);</code></pre>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.0
+ */
+
+interface MimeTypeUtil {
+  /**
+   * Returns the MIME type appropriate for a specified file extension.
+   * @param aFileExtensionExpression a file extension (e.g <em>pdf</em>) or an expression that ends with a period and a file extension (e.g <em>myfile.pdf</em> or <em>http://www.xyz.com/files/myfile.pdf</em>). Case insensitive.
+   * @return a MIME type that matches the extension in <code>aFileExtensionExpression</code>, or <code>null</code> if extension is unknown
+   * @see #getMimeType(String, String)
+   */
+  getMimeType(aFileExtensionExpression: java.lang.String): string;
+
+  /**
+   * Returns the MIME type (or a fallback MIME type) appropriate for a specified file extension.
+   * @param aFileExtensionExpression a file extension (e.g <em>pdf</em>) or an expression that ends with a period and a file extension (e.g <em>myfile.pdf</em> or <em>http://www.xyz.com/files/myfile.pdf</em>). Case insensitive.
+   * @param aFallbackMimeType the fallback MIME type to return if no MIME type can be found for <code>aFileExtensionExpression</code>
+   * @return a MIME type that matches the extension in <code>aFileExtensionExpression</code>, or <code>aFallbackMimeType</code> if extension is unknown
+   */
+  getMimeType(
+    aFileExtensionExpression: java.lang.String,
+    aFallbackMimeType: java.lang.String
+  ): string;
+
+  /**
+   * Returns the file extension for a specified MIME type.
+   * @param aMimeType a MIME type. Case insensitive.
+   * @return the lowercased default file extension for MIME type <code>aMimeType</code>, or <code>null</code> if <code>aMimeType</code> is unknown or has no single well-known extension (e.g. <em>application/octet-stream</em> or <em>text/plain</em>)
+   * @see #getExtension(String, String)
+   */
+  getExtension(aMimeType: java.lang.String): string;
+
+  /**
+   * Returns the file extension (or a fallback extension) for a specified MIME type.
+   * @param aMimeType a MIME type. Case insensitive.
+   * @param aFallbackExtension the fallback extension to return if no extension can be found for <code>aMimeType</code>
+   * @return the lowercased default file extension for MIME type <code>aMimeType</code>, or <code>aFallbackExtension</code> if <code>aMimeType</code> is unknown or has no single well-known extension (e.g. <em>application/octet-stream</em> or <em>text/plain</em>)
+   */
+  getExtension(
+    aMimeType: java.lang.String,
+    aFallbackExtension: java.lang.String
+  ): string;
+
+  /**
+   * Checks if a specified file extension is an image type (according to its mapped MIME type).
+   *
+   * <p>
+   *    <em>An image type has a MIME that starts with <code>image/</code></em>.
+   * </p>
+   * @param aFileExtensionExpression a file extension (e.g <em>png</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.png</em> or <em>http://www.xyz.com/files/myresource.png</em>). Case insensitive.
+   * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>image/*</code> MIME type, false otherwise
+   * @since Sitevision 4.0
+   */
+  isImageType(aFileExtensionExpression: java.lang.String): boolean;
+
+  /**
+   * Checks if a specified file extension is a text type (according to its mapped MIME type).
+   *
+   * <p>
+   *    <em>A text type has a MIME that starts with "<code>text/</code>"</em>.
+   * </p>
+   * @param aFileExtensionExpression a file extension (e.g <em>txt</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.txt</em> or <em>http://www.xyz.com/files/myresource.txt</em>). Case insensitive.
+   * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>text/*</code> MIME type, false otherwise
+   * @since Sitevision 4.1
+   */
+  isTextType(aFileExtensionExpression: java.lang.String): boolean;
+
+  /**
+   * Checks if a specified file extension is a text type (according to its mapped MIME type).
+   *
+   * <p>
+   *    <em>
+   *       A XML type typically has a MIME that starts with "<code>application/</code>" and ends with "<code>xml</code>".
+   *       This method will not include xml-based files covered by other categories (e.g. "office" types or the "svg" image type).
+   *    </em>
+   * </p>
+   * @param aFileExtensionExpression a file extension (e.g <em>xml</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.xml</em> or <em>http://www.xyz.com/files/myresource.xml</em>). Case insensitive.
+   * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>application/*xml</code> MIME type, false otherwise
+   * @since Sitevision 4.1
+   */
+  isXmlType(aFileExtensionExpression: java.lang.String): boolean;
+
+  /**
+   * Checks if a specified file extension is a video type (according to its mapped MIME type).
+   *
+   * <p>
+   *    <em>A video type has a MIME that starts with "<code>video/</code>"</em>.
+   * </p>
+   * @param aFileExtensionExpression a file extension (e.g <em>mov</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.mov</em> or <em>http://www.xyz.com/files/myresource.mov</em>). Case insensitive.
+   * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>video/*</code> MIME type, false otherwise
+   * @since Sitevision 4.1
+   */
+  isVideoType(aFileExtensionExpression: java.lang.String): boolean;
+
+  /**
+   * Checks if a specified file extension is a compressed/archive type (according to its mapped MIME type).
+   *
+   * <p>
+   *    Example of compressed MIME types:
+   * </p>
+   * <ul>
+   *    <li>application/zip</li>
+   *    <li>application/x-gzip</li>
+   *    <li>application/x-bzip</li>
+   *    <li>application/x-rar-compressed</li>
+   *    <li>application/x-lzh-compressed</li>
+   *    <li>application/x-7z-compressed</li>
+   *    <li>application/x-tar</li>
+   *    <li>application/vnd.ms-cab-compressed</li>
+   *    <li>application/java-archive</li>
+   * </ul>
+   * @param aFileExtensionExpression a file extension (e.g <em>zip</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.zip</em> or <em>http://www.xyz.com/files/myresource.zip</em>). Case insensitive.
+   * @return true if <code>aFileExtensionExpression</code> is mapped to a MIME type that is registered as compressed, false otherwise
+   * @since Sitevision 4.1
+   */
+  isCompressedType(aFileExtensionExpression: java.lang.String): boolean;
+
+  /**
+   * Checks if a specified file extension is a MS Word type (according to its mapped MIME type).
+   *
+   * <p>
+   *    Example of typical MS Word MIME types:
+   * </p>
+   * <ul>
+   *    <li>application/vnd.ms-word</li>
+   *    <li>application/vnd.openxmlformats-officedocument.wordprocessingml.document</li>
+   *    <li>application/vnd.openxmlformats-officedocument.wordprocessingml.template</li>
+   * </ul>
+   * @param aFileExtensionExpression a file extension (e.g <em>doc</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.doc</em> or <em>http://www.xyz.com/files/myresource.doc</em>). Case insensitive.
+   * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Word MIME type, false otherwise
+   * @since Sitevision 4.1
+   */
+  isMSWordType(aFileExtensionExpression: java.lang.String): boolean;
+
+  /**
+   * Checks if a specified file extension is a MS Excel type (according to its mapped MIME type).
+   *
+   * <p>
+   *    Example of typical MS Excel MIME types:
+   * </p>
+   * <ul>
+   *    <li>application/vnd.ms-excel</li>
+   *    <li>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</li>
+   *    <li>application/vnd.openxmlformats-officedocument.spreadsheetml.template</li>
+   * </ul>
+   * @param aFileExtensionExpression a file extension (e.g <em>xls</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.xls</em> or <em>http://www.xyz.com/files/myresource.xls</em>). Case insensitive.
+   * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Excel MIME type, false otherwise
+   * @since Sitevision 4.1
+   */
+  isMSExcelType(aFileExtensionExpression: java.lang.String): boolean;
+
+  /**
+   * Checks if a specified file extension is a MS Powerpoint type (according to its mapped MIME type).
+   *
+   * <p>
+   *    Example of typical MS Powerpoint MIME types:
+   * </p>
+   * <ul>
+   *    <li>application/vnd.ms-powerpoint</li>
+   *    <li>application/vnd.openxmlformats-officedocument.presentationml.presentation</li>
+   *    <li>application/vnd.openxmlformats-officedocument.presentationml.template</li>
+   * </ul>
+   * @param aFileExtensionExpression a file extension (e.g <em>ppt</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.ppt</em> or <em>http://www.xyz.com/files/myresource.ppt</em>). Case insensitive.
+   * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Powerpoint MIME type, false otherwise
+   * @since Sitevision 4.1
+   */
+  isMSPowerpointType(aFileExtensionExpression: java.lang.String): boolean;
+
+  /**
+   * Checks if a specified file extension is a MS Office type (according to its mapped MIME type).
+   *
+   * <p>
+   *    <em>
+   *       This is a convenience method that checks if <code>aFileExtensionExpression</code> is mapped to a MS Word/Excel/Powerpoint MIME type.
+   *       (i.e. a combination of {@link #isMSWordType(String)}, {@link #isMSExcelType(String)} and {@link #isMSPowerpointType(String)})
+   *    </em>
+   * </p>
+   * @param aFileExtensionExpression a file extension (e.g <em>doc</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.xls</em> or <em>http://www.xyz.com/files/myresource.ppt</em>). Case insensitive.
+   * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Word/Excel/Powerpoint MIME type, false otherwise
+   * @since Sitevision 4.1
+   */
+  isMSOfficeType(aFileExtensionExpression: java.lang.String): boolean;
+
+  /**
+   * Checks if a specified file extension is a font type (according to its mapped MIME type).
+   *
+   * <p>
+   *    Example of typical font MIME types:
+   * </p>
+   * <ul>
+   *    <li>font/woff2</li>
+   *    <li>font/woff</li>
+   *    <li>font/ttf</li>
+   *    <li>font/otf</li>
+   *    <li>font/sfnt</li>
+   *    <li>font/collection</li>
+   *    <li>application/x-font-ttf</li>
+   *    <li>application/vnd.ms-fontobject</li>
+   *    <li>application/x-dfont</li>
+   * </ul>
+   * @param aFileExtensionExpression a file extension (e.g <em>woff2</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.woff2</em> or <em>http://www.xyz.com/files/myresource.woff2</em>). Case insensitive.
+   * @return true if aFileExtensionExpression is mapped to a MIME type that is registered as font, false otherwise
+   * @since Sitevision 2022.10.1
+   */
+  isFontType(aFileExtensionExpression: java.lang.String): boolean;
+}

package/hidden/senselogic/sitevision/api/webresource/structure/ArchiveUtil/index.d.ts

@@ -0,0 +1,53 @@
+import Node from "../../../../../../javax/jcr/Node";
+
+/**
+ * Archive utility interface that handles nodes with primary node type <code>sv:archive</code>.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getArchiveUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ * @author Mikael Wikblom
+ * @since Sitevision 2.6.2
+ */
+
+interface ArchiveUtil {
+  /**
+   * <p>
+   *    Creates an archive as sub node of the specified parent.
+   * </p>
+   * <p>
+   *    The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}
+   *    or a {@code sv:collaborationGroupPage}.
+   *    If an other parent is specified a <code>ConstraintViolationException</code> is thrown.
+   * </p>
+   *
+   * <p>Any name can be given an archive. If null is provided a <code>NullPointerException</code> is thrown.</p>
+   *
+   * <p>The current user must be authorized to create archives and to do write operations on the parent node or
+   * a <code>ConstraintViolationException</code> will be thrown.</p>
+   *
+   * <p>Note that a new archive inherits metadata and permissions from its parent.</p>
+   * @param aParent the parent node of the sv:archive. May not be <code>null</code>
+   * @param aName the name of the archive. May not be <code>null</code>
+   * @return the newly created sv:archive node.
+   * @throws ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create an archive
+   * @throws RepositoryException if something else goes wrong
+   */
+  createArchive(aParent: Node, aName: java.lang.String): Node;
+
+  /**
+   * <p>Alters the name of an archive. If no archive is specified a <code>NullPointerException</code>
+   * is thrown. If the node is not a sv:archive an <code>IllegalArgumentException</code> is thrown.</p>
+   *
+   * <p>Any name can be given an archive. If null is provided a <code>NullPointerException</code> is thrown.</p>
+   *
+   * <p>The current user must be authorized to do write operations on the archive or
+   * a <code>ConstraintViolationException</code> will be thrown.</p>
+   * @param anArchive the archive that should be renamed. May not be <code>null</code>
+   * @param aName the new name of the archive. May not be <code>null</code>
+   * @throws ConstraintViolationException if the current user is not authorized to alter the name of the archive
+   * @throws RepositoryException if something else goes wrong
+   */
+  renameArchive(anArchive: Node, aName: java.lang.String): void;
+}

package/hidden/senselogic/sitevision/api/webresource/structure/FolderUtil/index.d.ts

@@ -0,0 +1,107 @@
+import Node from "../../../../../../javax/jcr/Node";
+
+/**
+ * Folder utility interface that handles nodes with primary node type <code>sv:folder</code>.
+ *
+ * <p>
+ *    <em>Note!</em> This interface is used to <em>create</em> folders. You would typically use
+ *    {@link senselogic.sitevision.api.webresource.structure.StructureUtil} to <em>move</em> a folder
+ *    and {@link senselogic.sitevision.api.webresource.structure.TrashcanUtil} to <em>delete</em> a folder.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getFolderUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ * @author Mikael Wikblom
+ * @since Sitevision 2.6.2
+ */
+
+interface FolderUtil {
+  /**
+   * <p>
+   *    Creates a folder as sub node of the specified parent.
+   * </p>
+   * <p>
+   *    The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}, {@code sv:collaborationGroupPage},
+   *    {@code sv:imageRepository}, {@code sv:localImageRepository}, {@code sv:personalImageRepository},
+   *    {@code sv:fileRepository}, {@code sv:localFileRepository}, {@code sv:personalFileRepository}
+   *    or {@code sv:templateRepository}.
+   *    If an other parent is specified an <code>ConstraintViolationException</code> is thrown.
+   * </p>
+   *
+   * <p>Any name can be given the folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
+   *
+   * <p>The current user must be authorized to create folders and to do write operations on the parent node or
+   * a <code>ConstraintViolationException</code> will be thrown.</p>
+   *
+   * <p>Note that a new folder inherits metadata and permissions from its parent.</p>
+   * @param aParent the parent node of the sv:folder. May not be <code>null</code>
+   * @param aName the name of the folder. May not be <code>null</code>
+   * @return the newly created sv:folder node.
+   * @throws ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create a folder
+   * @throws RepositoryException if something else goes wrong
+   */
+  createFolder(aParent: Node, aName: java.lang.String): Node;
+
+  /**
+   * <p>Alters the name of a folder. If no folder is specified a <code>NullPointerException</code>
+   * is thrown. If the node is not a sv:folder an <code>IllegalArgumentException</code> is thrown.</p>
+   *
+   * <p>Any name can be given a folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
+   *
+   * <p>The current user must be authorized to do write operations on the folder or
+   * a <code>ConstraintViolationException</code> will be thrown.</p>
+   * @param aFolder the sv:folder that should be renamed. May not be <code>null</code>
+   * @param aName the new name of the folder. May not be <code>null</code>
+   * @throws ConstraintViolationException if the current user is not authorized to alter the name of the folder
+   * @throws RepositoryException if something else goes wrong
+   */
+  renameFolder(aFolder: Node, aName: java.lang.String): void;
+
+  /**
+   * Modifies versioning for a file folder (versioning only applies to new files created in the file folder).
+   *
+   * <p>
+   *    If no folder is specified a <code>NullPointerException</code> is thrown.
+   *    If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    Current user must be authorized to do write operations on the folder or
+   *    a <code>ConstraintViolationException</code> will be thrown.
+   * </p>
+   * @param aFolder the sv:folder. May not be null
+   * @param aVersioned the new state of versioning for aFolder
+   * @throws ConstraintViolationException if the current user is not authorized to mutate aFolder
+   * @throws RepositoryException if something else goes wrong
+   * @since Sitevision 9.1
+   */
+  setVersioned(aFolder: Node, aVersioned: boolean): void;
+
+  /**
+   * Modifies download protection for a file folder (download protection only applies to new files created in the file folder).
+   *
+   * <p>
+   *    Current user (the invoker of this method) must have WRITE permission and MANAGE_DOWNLOAD_PROTECTION permission on the folder node that
+   *    should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
+   *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_DOWNLOAD_PROTECTION}).
+   * </p>
+   *
+   * <p>
+   *    If no folder is specified a <code>NullPointerException</code> is thrown.
+   *    If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    <em>Tip! Use {@link senselogic.sitevision.api.property.PropertyUtil} or {@link senselogic.sitevision.api.property.Properties}
+   *    to check current state, i.e. the "downloadProtected" boolean property.</em>
+   * </p>
+   * @param aFolder the sv:folder. May not be null
+   * @param aDownloadProtected the new state of download protection for aFolder
+   * @throws ConstraintViolationException if the current user is not authorized to mutate aFolder
+   * @throws RepositoryException if something else goes wrong
+   * @since Sitevision 2022.08.1
+   */
+  setDownloadProtected(aFolder: Node, aDownloadProtected: boolean): void;
+}