@sitevision/api 2025.3.1 → 2025.4.1

package/index.d.ts

@@ -25,6 +25,7 @@ import './server/DateUtil';
 import './server/DecorationUtil';
 import './server/DeviceUtil';
 import './server/DimensionMode';
+import './server/DirectMessageUtil';
 import './server/DirectoryUtil';
 import './server/DocType';
 import './server/DocTypeUtil';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2025.3.1",
+  "version": "2025.4.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -30,5 +30,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "bbf94aa279c6aa74316f75eab9093a265acf169b"
+  "gitHead": "685a5b71ce767337f6f5d8cf0ff10dadafda91d6"
 }

package/server/ChannelUtil/index.d.ts

@@ -11,7 +11,7 @@ import type { Node } from "../../types/javax/jcr/Node";
  *     See {@link MessagesFactory} for how to obtain an instance of the <code>MessagesFactory</code> interface.
  *  </p>
  * @author Elias Abrache
- * @since Sitevision 2024.05.01
+ * @since Sitevision 2024.05.1
  */
 export interface ChannelUtil {
   /**

package/server/CollaborationGroupFolderUtil/index.d.ts

@@ -36,6 +36,28 @@ export interface CollaborationGroupFolderUtil {
     aCollaborationGroupFolder: Node,
     aGroupName: String | string
   ): boolean;
+
+  /**
+   * Creates a collaboration group folder.
+   *
+   *  <p>
+   *     <em>Permission note!</em> Current user must have
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_COLLABORATION_GROUP_FOLDER}
+   *     on the parent where the collaboration group folder is created.
+   *  </p>
+   * @param aParent the parent node of the sv:collaborationGroupFolder. May not be null
+   * @param aGroupFolderName the name of the collaboration group folder. May not be null or whitespace-only
+   * @return The created collaboration group folder (sv:collaborationGroupFolder)
+   * @throws java.lang.NullPointerException if aParent or aGroupFolderName is null
+   * @throws java.lang.IllegalArgumentException if aGroupFolderName is whitespace only
+   * @throws ConstraintViolationException if social collaboration is not enabled on the site of aParent,&#xA; if aParent is of invalid type, or if current user is not authorized to create the collaboration group folder
+   * @throws RepositoryException if something else goes wrong
+   * @since Sitevision 2025.04.1
+   */
+  createCollaborationGroupFolder(
+    aParent: Node,
+    aGroupFolderName: String | string
+  ): Node;
 }
 
 declare namespace CollaborationGroupFolderUtil {}

package/server/CollaborationGroupFolderUtil/index.js

@@ -6,5 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _default = exports["default"] = {
   getDefaultCollaborationGroupFolder: function getDefaultCollaborationGroupFolder() {},
-  containsCollaborationGroup: function containsCollaborationGroup() {}
+  containsCollaborationGroup: function containsCollaborationGroup() {},
+  createCollaborationGroupFolder: function createCollaborationGroupFolder() {}
 };

package/server/DirectMessageUtil/index.d.ts

@@ -0,0 +1,45 @@
+import type { Collection } from "../../types/java/util/Collection";
+import type { Node } from "../../types/javax/jcr/Node";
+
+/**
+ * Direct Message utility interface.
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link MessagesFactory#getDirectMessageUtil()}.
+ *     See {@link MessagesFactory} for how to obtain an instance of the <code>MessagesFactory</code> interface.
+ *  </p>
+ * @author Elias Abrache
+ * @since Sitevision 2025.04.1
+ */
+export interface DirectMessageUtil {
+  /**
+   * Retrieves an existing direct message conversation for the current user identity
+   *  that includes the specified members.
+   *  The current user identity is always included in the conversation.
+   * @param aMembers array of sv:userIdentity nodes representing other participants&#xA; in the conversation (including or excluding current user identity, who is always implicitly included as member anyway).
+   * @return a sv:directMessageConversation node representing the direct message conversation for the current user identity,&#xA; or null if no matching conversation is found.
+   * @throws ConstraintViolationException if social collaboration is not enabled on the site.
+   * @throws IllegalStateException if current user doesn't have a user identity.
+   * @throws IllegalArgumentException if aMembers is null or empty. Or if any of the specified members is not&#xA; a valid conversation participant.
+   */
+  getConversation(aMembers: Collection | unknown[]): Node;
+
+  /**
+   * Creates a new direct message conversation for the current user identity with the specified members.
+   *  If an existing conversation with the same participants (including the current user identity) exists,
+   *  it will be returned instead of creating a new one.
+   * @param aMembers array of sv:userIdentity nodes representing other participants&#xA; in the conversation (including or excluding current user identity, who is always implicitly included as member anyway).
+   * @return a sv:directMessageConversation node representing the newly created or retrieved direct message conversation&#xA; for the current user identity.
+   * @throws ConstraintViolationException if social collaboration is not enabled on the site or&#xA; if the conversation could not be created.
+   * @throws IllegalStateException if current user doesn't have a user identity.
+   * @throws IllegalArgumentException if aMembers is null or empty. Or if any of the specified members is not&#xA; a valid conversation participant.
+   */
+  createConversation(aMembers: Collection | unknown[]): Node;
+}
+
+declare namespace DirectMessageUtil {}
+
+declare var directMessageUtil: DirectMessageUtil;
+
+export default directMessageUtil;

package/server/DirectMessageUtil/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = exports["default"] = {
+  getConversation: function getConversation() {},
+  createConversation: function createConversation() {}
+};

package/server/DocType/index.d.ts

@@ -1,19 +1,22 @@
 /**
- * Defines doctypes rendered by Sitevision.
+ * Defines html DOCTYPE's.
  *
  *  <p>
+ *     <strong>Note! Sitevision pages are always served as {@link #HTML5}!</strong>
+ *  </p>
+ *  <p>
  *     Example of how to get the {@link #HTML5} type:
  *  </p>
  *  <ul>
  *     <li>
- *        Using <strong>Velocity:</strong><pre><code>
- *        #set ($instanceCreatorUtil = $sitevisionUtils.instanceCreatorUtil)
- *        #set ($enumClassName = 'senselogic.sitevision.api.webresource.doctype.DocType')
- *        #set ($html5Enum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'HTML5'))</code></pre>
+ *        Using server-side <strong>JavaScript:</strong><pre><code>
+ *  const html5Enum = require('DocType.HTML5');</code></pre>
  *     </li>
  *     <li>
- *        Using server-side <strong>JavaScript:</strong><pre><code>
- *        var html5Enum = require('DocType.HTML5');</code></pre>
+ *        Using <strong>Velocity:</strong><pre><code>
+ *  #set ($instanceCreatorUtil = $sitevisionUtils.instanceCreatorUtil)
+ *  #set ($enumClassName = 'senselogic.sitevision.api.webresource.doctype.DocType')
+ *  #set ($html5Enum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'HTML5'))</code></pre>
  *     </li>
  *  </ul>
  * @author Magnus Lövgren

package/server/DocTypeUtil/index.d.ts

@@ -2,135 +2,146 @@ import type { Node } from "../../types/javax/jcr/Node";
 import type DocType from "../DocType";
 
 /**
- * A utility interface for checking what DOCTYPE a page uses.
+ * A deprecated DOCTYPE utility interface.
  *
  *  <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.
+ *     <strong>NOTE! This interface is deprecated and should typically not be used!
+ *     All methods have a fixed behaviour, i.e. always returns <code>true</code> or <code>false</code>
+ *     since all Sitevision pages use HTML5.</strong>
+ *  </p>
+ *
+ *  <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
+ * @deprecated This interface is deprecated due to obsolete functionality - pages are always HTML5.&#xA; Last remaining legacy setting to use other type was removed in Sitevision 2025.04.1.
  */
 export 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
+   * This method always return true since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for current page is HTML 4.01 Transitional or HTML5.</p>
+   * @return true
    */
   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
+   * This method always return true since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for a certain page is HTML 4.01 Transitional or HTML5.</p>
+   * @param aPageNode this argument will be completely ignored
+   * @return true
    */
   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
+   * This method always return false since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for current page is HTML 4.01 Transitional.</p>
+   * @return false
    * @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
+   * This method always return false since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for a certain page is HTML 4.01 Transitional.</p>
+   * @param aPageNode this argument will be completely ignored
+   * @return false
    */
   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
+   * This method always return true since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for current page is HTML5.</p>
+   * @return true
    * @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
+   * This method always return true since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for a certain page is HTML5.</p>
+   * @param aPageNode this argument will be completely ignored
+   * @return true
    */
   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
+   * This method always return false since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for current page is XHTML 1.0 Transitional or XHTML 1.0 Strict.</p>
+   * @return false
    */
   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
+   * This method always return false since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for a certain page is XHTML 1.0 Transitional or XHTML 1.0 Strict.</p>
+   * @param aPageNode this argument will be completely ignored
+   * @return false
    */
   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
+   * This method always return false since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for current page is XHTML 1.0 Transitional.</p>
+   * @return false
    * @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
+   * This method always return false since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for a certain page is XHTML 1.0 Transitional.</p>
+   * @param aPageNode this argument will be completely ignored
+   * @return false
    */
   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
+   * This method always return false since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for current page is XHTML 1.0 Strict.</p>
+   * @return false
    * @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
+   * This method always return false since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Checks if the doctype for a certain page is XHTML 1.0 Strict.</p>
+   * @param aPageNode this argument will be completely ignored
+   * @return false
    */
   isXhtmlStrict(aPageNode: Node): boolean;
 
   /**
-   * Gets the doctype for current page.
-   * @return the doctype for current page
+   * This method always return {@link DocType#HTML5} since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Gets the doctype for current page.</p>
+   * @return {@link DocType#HTML5}
    */
   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>
+   * This method always return {@link DocType#HTML5} since all pages are always HTML5.
+   *  <p style="text-decoration:line-through">Gets the doctype for a certain page.</p>
+   * @param aPageNode this argument will be completely ignored
+   * @return {@link DocType#HTML5}
    */
   getDocType(aPageNode: Node): DocType;
 
   /**
-   * Checks if the doctype for current page matches a certain DocType.
+   * This method always return true if the aDocType argument is {@link DocType#HTML5}.
+   *  <p style="text-decoration:line-through">Checks if the doctype for current page matches a certain DocType.</p>
    * @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
+   * @return true if aDocType is {@link DocType#HTML5}, false otherwise
    */
   isDocType(aDocType: DocType): boolean;
 
   /**
-   * Checks if the doctype for a certain page matches a certain DocType.
-   * @param aPageNode the page tree node to check
+   * This method always return true if the aDocType argument is {@link DocType#HTML5}.
+   *  <p style="text-decoration:line-through">Checks if the doctype for a certain page matches a certain DocType.</p>
+   * @param aPageNode this argument will be completely ignored
    * @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
+   * @return true if aDocType is {@link DocType#HTML5}, false otherwise
    */
   isDocType(aPageNode: Node, aDocType: DocType): boolean;
 }

package/server/MessagesFactory/index.d.ts

@@ -1,6 +1,7 @@
 import type { ChannelUtil } from "../ChannelUtil";
 import type { Node } from "../../types/javax/jcr/Node";
 import type { ChannelWrapper } from "../../types/senselogic/sitevision/api/message/ChannelWrapper";
+import type { DirectMessageUtil } from "../DirectMessageUtil";
 
 /**
  * Factory for creating messages-related instances.
@@ -11,13 +12,13 @@ import type { ChannelWrapper } from "../../types/senselogic/sitevision/api/messa
  *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
  *  </p>
  * @author Elias Abrache
- * @since Sitevision 2024.03.01
+ * @since Sitevision 2024.03.1
  */
 export interface MessagesFactory {
   /**
    * Gets an instance of a channel utility class.
    * @return a channel utility class
-   * @since Sitevision 2024.05.01
+   * @since Sitevision 2024.05.1
    */
   getChannelUtil(): ChannelUtil;
 
@@ -27,6 +28,13 @@ export interface MessagesFactory {
    * @return a channel wrapper for <code>aChannel</code>, or <code>null</code> if <code>aChannel</code>&#xA; isn't a channel, is archived, Social Collaboration isn't activated or operating user doesn't have a social user identity.
    */
   getChannelWrapper(aChannel: Node): ChannelWrapper;
+
+  /**
+   * Gets an instance of a direct message utility class.
+   * @return a direct message utility class
+   * @since Sitevision 2025.04.1
+   */
+  getDirectMessageUtil(): DirectMessageUtil;
 }
 
 declare namespace MessagesFactory {}

package/server/MessagesFactory/index.js

@@ -6,5 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _default = exports["default"] = {
   getChannelUtil: function getChannelUtil() {},
-  getChannelWrapper: function getChannelWrapper() {}
+  getChannelWrapper: function getChannelWrapper() {},
+  getDirectMessageUtil: function getDirectMessageUtil() {}
 };

package/server/PermissionUtil.Permission/index.d.ts

@@ -28,6 +28,7 @@ declare enum Permission {
   DELETE,
   CREATE_ARCHIVE,
   CREATE_COLLABORATION_GROUP,
+  CREATE_COLLABORATION_GROUP_FOLDER,
   CREATE_FOLDER,
   CREATE_LAYOUT,
   CREATE_PAGE,

package/server/PermissionUtil.Permission/index.js

@@ -13,6 +13,7 @@ var _default = exports["default"] = {
   DELETE: "DELETE",
   CREATE_ARCHIVE: "CREATE_ARCHIVE",
   CREATE_COLLABORATION_GROUP: "CREATE_COLLABORATION_GROUP",
+  CREATE_COLLABORATION_GROUP_FOLDER: "CREATE_COLLABORATION_GROUP_FOLDER",
   CREATE_FOLDER: "CREATE_FOLDER",
   CREATE_LAYOUT: "CREATE_LAYOUT",
   CREATE_PAGE: "CREATE_PAGE",

package/server/Utils/index.d.ts

@@ -499,8 +499,8 @@ export interface Utils {
   getMimeTypeUtil(): MimeTypeUtil;
 
   /**
-   * Gets an instance of a DOCTYPE utility class
-   * @return a DOCTYPE utility class
+   * Gets an instance of a deprecated DOCTYPE utility class
+   * @return a deprecated DOCTYPE utility class
    * @since Sitevision 3.0
    */
   getDocTypeUtil(): DocTypeUtil;

package/types/senselogic/sitevision/api/message/ChannelWrapper/index.d.ts

@@ -16,7 +16,7 @@ import type { Wrapper } from "../../base/Wrapper";
  *     See {@link MessagesFactory} for how to obtain an instance of the MessagesFactory interface.
  *  </p>
  * @author Elias Abrache
- * @since Sitevision 2024.03.01
+ * @since Sitevision 2024.03.1
  */
 export type ChannelWrapper = Wrapper & {
   /**
@@ -95,7 +95,7 @@ export type ChannelWrapper = Wrapper & {
    * Checks if a user identity is a member of the wrapped channel.
    * @param aUserIdentity a user identity (or user)
    * @return true if aUserIdentity is a member of the wrapped channel, false otherwise.&#xA; false is always returned if aUserIdentity is null.
-   * @since Sitevision 2024.05.01
+   * @since Sitevision 2024.05.1
    */
   isMember(aUserIdentity: Node): boolean;
 
@@ -112,7 +112,7 @@ export type ChannelWrapper = Wrapper & {
    *  </p>
    * @param aChannelName the new name of the channel
    * @return true if channel could be renamed to aChannelName, false otherwise.
-   * @since Sitevision 2024.05.01
+   * @since Sitevision 2024.05.1
    */
   renameChannel(aChannelName: String | string): boolean;
 
@@ -125,7 +125,7 @@ export type ChannelWrapper = Wrapper & {
    *  </p>
    * @param aChannelDescription the new description of the channel
    * @return true if channel description was set to aChannelDescription, false otherwise.
-   * @since Sitevision 2024.05.01
+   * @since Sitevision 2024.05.1
    */
   setChannelDescription(aChannelDescription: String | string): boolean;
 };

package/types/senselogic/sitevision/api/portlet/GenericConfigPortlet/index.d.ts

@@ -86,6 +86,7 @@ import type { String } from "../../../../../java/lang/String";
  *  &lt;/portlet-app&gt;</code></pre></div>
  * @author Magnus Lövgren
  * @since Sitevision 3.0
+ * @deprecated portlet applications are the legacy way of extending Sitevision. WebApp/RESTApp technique should be used instead as of Sitevision 5.&#xA; This class will be removed in a future version of Sitevision.
  */
 export type GenericConfigPortlet = GenericSiteVisionPortlet & {
   /**

package/types/senselogic/sitevision/api/portlet/GenericSiteVisionPortlet/index.d.ts

@@ -7,6 +7,7 @@ import type { PrintWriter } from "../../../../../java/io/PrintWriter";
  * This class that can be extended when creating GenericPortlet-based portlets that needs easy access to the Sitevision API.
  * @author Magnus Lövgren
  * @since Sitevision 3.0
+ * @deprecated portlet applications are the legacy way of extending Sitevision. WebApp/RESTApp technique should be used instead as of Sitevision 5.
 This class will be removed in a future version of Sitevision.
  */
 export type GenericSiteVisionPortlet = {
   /**