@sitevision/api 2024.4.2 → 2024.7.1

package/index.d.ts

@@ -6,6 +6,7 @@ import './server/AuthenticationUtil';
 import './server/BookmarkUtil';
 import './server/BuddyIconRenderer';
 import './server/BuddyIconRenderer.BuddyIconSize';
+import './server/ChannelUtil';
 import './server/ClientUtil';
 import './server/CollaborationFactory';
 import './server/CollaborationGroupFolderUtil';

package/package.json

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

package/server/ChannelUtil/index.d.ts

@@ -0,0 +1,73 @@
+import type { String } from "../../types/java/lang/String";
+
+import type { Node } from "../../types/javax/jcr/Node";
+
+/**
+ * Channel utility interface.
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link MessagesFactory#getChannelUtil()}.
+ *     See {@link MessagesFactory} for how to obtain an instance of the <code>MessagesFactory</code> interface.
+ *  </p>
+ * @author Elias Abrache
+ * @since Sitevision 2024.05.01
+ */
+export interface ChannelUtil {
+  /**
+   * Creates a channel.
+   *  <p>
+   *     A <code>ConstraintViolationException</code> will be thrown if social collaboration is not enabled
+   *     Or if current user is attempting to create a private channel without
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_PRIVATE_CHANNELS} permission.
+   *  </p>
+   *
+   *  <p>
+   *     A <code>IllegalArgumentException</code> will be thrown if aName is null, blank or exceeds 80 characters.
+   *  </p>
+   *
+   *  <p>
+   *     A <code>ItemExistsException</code> will be thrown if a channel with the same name already exists.
+   *  </p>
+   *
+   *  <p>
+   *     A <code>RepositoryException</code> will be thrown If an error occurs while fetching channels
+   *  </p>
+   * @param aName the name of the channel (Must be unique and must not exceed 80 characters)
+   * @param aDescription the description of the channel
+   * @param aPrivate whether the channel should be private or not
+   * @throws RepositoryException if an error occurs.
+   * @return a channel wrapper for the newly created <code>channel</code>, or <code>null</code>.
+   */
+  createChannel(
+    aName: String | string,
+    aDescription: String | string,
+    aPrivate: boolean
+  ): Node;
+
+  /**
+   * Searches for a channel by name.
+   *
+   *  <p>
+   *     <em>Permission note</em> Private channels can only be found by members.
+   *  </p>
+   *
+   *  <p>
+   *     A <code>ConstraintViolationException</code> will be thrown if social collaboration is not enabled.
+   *  </p>
+   *
+   *  <p>
+   *     A <code>RepositoryException</code> will be thrown if an error occurs while fetching channels.
+   *  </p>
+   * @return the channel node, or null.
+   * @param aChannelName the name of the channel to search for.
+   * @throws RepositoryException if an error occurs.
+   */
+  findChannelByName(aChannelName: String | string): Node;
+}
+
+declare namespace ChannelUtil {}
+
+declare var channelUtil: ChannelUtil;
+
+export default channelUtil;

package/server/ChannelUtil/index.js

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

package/server/ImageUtil/index.d.ts

@@ -266,6 +266,42 @@ export interface ImageUtil {
    * @since Sitevision 4.5.5.2
    */
   toBase64(aImage: Node): string;
+
+  /**
+   * Sets the alt property for an image Node.
+   *
+   *  <p>
+   *     <strong>Permission note!</strong> Current user (the invoker of this method) must have
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE} permission
+   *     on the image node that should be updated. <em>Updating an image for a <code>sv:userIdentity</code> requires
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES MANAGE_USER_IDENTITIES} permission
+   *     on current page.</em>
+   *  </p>
+   * @param aImage the sv:image Node, may not be null
+   * @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
+   */
+  setAltText(aImage: Node, aAltText: String | string): void;
+
+  /**
+   * Sets the caption property for an image Node.
+   *
+   *  <p>
+   *     <strong>Permission note!</strong> Current user (the invoker of this method) must have
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE} permission
+   *     on the image node that should be updated. <em>Updating an image for a <code>sv:userIdentity</code> requires
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES MANAGE_USER_IDENTITIES} permission
+   *     on current page.</em>
+   *  </p>
+   * @param aImage the sv:image Node, may not be null
+   * @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
+   */
+  setCaptionText(aImage: Node, aCaptionText: String | string): void;
 }
 
 declare namespace ImageUtil {}

package/server/ImageUtil/index.js

@@ -13,6 +13,8 @@ var _default = {
   updateBinaryContentFromBase64: function updateBinaryContentFromBase64() {},
   updateBinaryContentFromTemporary: function updateBinaryContentFromTemporary() {},
   renameImage: function renameImage() {},
-  toBase64: function toBase64() {}
+  toBase64: function toBase64() {},
+  setAltText: function setAltText() {},
+  setCaptionText: function setCaptionText() {}
 };
 exports["default"] = _default;

package/server/MessagesFactory/index.d.ts

@@ -1,3 +1,4 @@
+import type { ChannelUtil } from "../ChannelUtil";
 import type { Node } from "../../types/javax/jcr/Node";
 import type { ChannelWrapper } from "../../types/senselogic/sitevision/api/message/ChannelWrapper";
 
@@ -13,6 +14,13 @@ import type { ChannelWrapper } from "../../types/senselogic/sitevision/api/messa
  * @since Sitevision 2024.03.01
  */
 export interface MessagesFactory {
+  /**
+   * Gets an instance of a channel utility class.
+   * @return a channel utility class
+   * @since Sitevision 2024.05.01
+   */
+  getChannelUtil(): ChannelUtil;
+
   /**
    * Gets a wrapper for the specified channel.
    * @param aChannel the channel node (node of type sv:topic).

package/server/MessagesFactory/index.js

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

package/server/appData/index.d.ts

@@ -4,6 +4,7 @@ export interface AppData {
   get(...key: string[]): unknown;
   getNode(key: string): Node;
   getArray(key: string): Node[];
+  getNumber(key: string): number;
 }
 
 declare namespace AppData {}

package/server/appData/index.js

@@ -7,6 +7,7 @@ exports["default"] = void 0;
 var _default = {
   get: function get() {},
   getArray: function getArray() {},
-  getNode: function getNode() {}
+  getNode: function getNode() {},
+  getNumber: function getNumber() {}
 };
 exports["default"] = _default;

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

@@ -1,5 +1,6 @@
 import type { Node } from "../../../../../javax/jcr/Node";
 
+import type { String } from "../../../../../java/lang/String";
 import type { Wrapper } from "../../base/Wrapper";
 
 /**
@@ -34,8 +35,9 @@ export type ChannelWrapper = Wrapper & {
    *     <strong>Permission notes!</strong>
    *  </p>
    *  <p>
-   *     <em>Open channels</em> require the operating user to either have membership or the
-   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_CHANNELS} permission.
+   *     <em>Open channels</em> require the operating user to have either membership or the
+   *      {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_CHANNELS} permission
+   *      when adding members other than self.
    *  </p>
    *  <p>
    *     <em>Private channels</em> require the operating user to have membership.
@@ -88,4 +90,42 @@ export type ChannelWrapper = Wrapper & {
    * @return true if aUserIdentity was removed as member from the wrapped channel, false otherwise.&#xA; false is always returned if aUserIdentity is null or not a member of the wrapped channel.
    */
   removeMember(aUserIdentity: Node): boolean;
+
+  /**
+   * 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
+   */
+  isMember(aUserIdentity: Node): boolean;
+
+  /**
+   * Alters the name of the wrapped channel.
+   *
+   *  <p>
+   *     <em>Permission note</em> Only the author or members with the
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_CHANNELS} permission can alter the channel name.
+   *  </p>
+   *
+   *  <p>
+   *     The new channel name most not exceed 80 characters in length and must be unique otherwise false will be returned.
+   *  </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
+   */
+  renameChannel(aChannelName: String | string): boolean;
+
+  /**
+   * Alters the description of the wrapped channel.
+   *
+   *  <p>
+   *     <em>Permission note</em> Only the author or members with the
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_CHANNELS} permission can alter the channel description.
+   *  </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
+   */
+  setChannelDescription(aChannelDescription: String | string): boolean;
 };

package/types/senselogic/sitevision/api/message/ChannelWrapper/index.js

@@ -6,6 +6,9 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _default = {
   addMember: function addMember() {},
-  removeMember: function removeMember() {}
+  removeMember: function removeMember() {},
+  isMember: function isMember() {},
+  renameChannel: function renameChannel() {},
+  setChannelDescription: function setChannelDescription() {}
 };
 exports["default"] = _default;