@sitevision/api 2024.1.2 → 2024.3.1

package/index.d.ts

@@ -58,6 +58,7 @@ import './server/MailBuilder';
 import './server/MailUtil';
 import './server/MathInstance';
 import './server/MessageDigesterFactory';
+import './server/MessagesFactory';
 import './server/MetadataDefinitionUtil';
 import './server/MetadataUtil';
 import './server/MimeTypeUtil';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2024.1.2",
+  "version": "2024.3.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -30,5 +30,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "162f416958e93e3cc24c7b23a5eeafc46db6c2e7"
+  "gitHead": "ac4d35923f8a61c4fdaccbd6ffe6c46be9fddd8a"
 }

package/server/MessagesFactory/index.d.ts

@@ -0,0 +1,28 @@
+import type { Node } from "../../types/javax/jcr/Node";
+import type { ChannelWrapper } from "../../types/senselogic/sitevision/api/message/ChannelWrapper";
+
+/**
+ * Factory for creating messages-related instances.
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.Utils#getMessagesFactory()}.
+ *     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
+ */
+export interface MessagesFactory {
+  /**
+   * Gets a wrapper for the specified channel.
+   * @param aChannel the channel node (node of type sv:topic).
+   * @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;
+}
+
+declare namespace MessagesFactory {}
+
+declare var messagesFactory: MessagesFactory;
+
+export default messagesFactory;

package/server/MessagesFactory/index.js

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

package/server/NodeTypeUtil/index.d.ts

@@ -1086,6 +1086,12 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    */
   MARKETPLACE_HEADLESS_CUSTOM_MODULE_TYPE: "sv:marketplaceHeadlessCustomModule";
 
+  /**
+   * The primary node type name for the Marketplace widget custom module type.
+   * @since Sitevision 2024.02.1
+   */
+  MARKETPLACE_WIDGET_CUSTOM_MODULE_TYPE: "sv:marketplaceWidgetCustomModule";
+
   /**
    * The primary node type name for the responsive breakpoint repository type.
    * @since Sitevision 6.2
@@ -1176,6 +1182,18 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    */
   WORK_STATUS_TEMPLATE_REPOSITORY_TYPE: "sv:workStatusTemplateRepository";
 
+  /**
+   * The primary node type name for the dashboard type.
+   * @since Sitevision 2024.02.1
+   */
+  DASHBOARD_TYPE: "sv:dashboard";
+
+  /**
+   * The primary node type name for the widget custom module type.
+   * @since Sitevision 2024.02.1
+   */
+  WIDGET_CUSTOM_MODULE_TYPE: "sv:widgetCustomModule";
+
   /**
    * Checks if a node is a layout.
    * @param aNode the node to be checked

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

@@ -53,6 +53,7 @@ declare enum Permission {
   MANAGE_TYPES_IDENTIFIERS,
   MANAGE_CUSTOM_SEARCH_INDEX,
   MANAGE_PUBLISHING_LOCK,
+  MANAGE_DASHBOARDS,
 }
 
 export default Permission;

package/server/PermissionUtil.Permission/index.js

@@ -37,6 +37,7 @@ var _default = {
   MANAGE_PINNING: "MANAGE_PINNING",
   MANAGE_TYPES_IDENTIFIERS: "MANAGE_TYPES_IDENTIFIERS",
   MANAGE_CUSTOM_SEARCH_INDEX: "MANAGE_CUSTOM_SEARCH_INDEX",
-  MANAGE_PUBLISHING_LOCK: "MANAGE_PUBLISHING_LOCK"
+  MANAGE_PUBLISHING_LOCK: "MANAGE_PUBLISHING_LOCK",
+  MANAGE_DASHBOARDS: "MANAGE_DASHBOARDS"
 };
 exports["default"] = _default;

package/server/PortletContextUtil/index.d.ts

@@ -50,6 +50,13 @@ export interface PortletContextUtil extends PortletContextUtilConstants {
    */
   getCurrentModuleElement(): Node;
 
+  /**
+   * Gets current dashboard node (applicable during render of a sv:widgetCustomModule).
+   * @return current dashboard as <code>Node</code>, or <code>null</code> if indeterminable&#xA; (i.e. this method is not called from within a sv:widgetCustomModule)
+   * @since Sitevision 2024.02.1
+   */
+  getCurrentDashboard(): Node;
+
   /**
    * Gets current Locale.
    * @return current <code>Locale</code>, or default <code>Locale</code> if indeterminable

package/server/PortletContextUtil/index.js

@@ -8,6 +8,7 @@ var _default = {
   getCurrentPage: function getCurrentPage() {},
   getCurrentPortlet: function getCurrentPortlet() {},
   getCurrentModuleElement: function getCurrentModuleElement() {},
+  getCurrentDashboard: function getCurrentDashboard() {},
   getCurrentLocale: function getCurrentLocale() {},
   getCurrentUser: function getCurrentUser() {},
   getCurrentUserIdentity: function getCurrentUserIdentity() {},

package/server/Utils/index.d.ts

@@ -85,6 +85,7 @@ import type { FormatterBuilderFactory } from "../FormatterBuilderFactory";
 import type { TextModuleRendererBuilder } from "../TextModuleRendererBuilder";
 import type { TagUtil } from "../TagUtil";
 import type { AliasUtil } from "../AliasUtil";
+import type { MessagesFactory } from "../MessagesFactory";
 
 /**
  * Main entry point to get instances of interfaces in the Sitevision Utility API.
@@ -747,6 +748,13 @@ export interface Utils {
    * @since Sitevision 2022.10.2
    */
   getAliasUtil(): AliasUtil;
+
+  /**
+   * Gets an instance of a messages factory class.
+   * @return a messages factory class
+   * @since Sitevision 2024.03.01
+   */
+  getMessagesFactory(): MessagesFactory;
 }
 
 declare namespace Utils {}

package/server/Utils/index.js

@@ -87,6 +87,7 @@ var _default = {
   getFormatterBuilderFactory: function getFormatterBuilderFactory() {},
   getTextModuleRendererBuilder: function getTextModuleRendererBuilder() {},
   getTagUtil: function getTagUtil() {},
-  getAliasUtil: function getAliasUtil() {}
+  getAliasUtil: function getAliasUtil() {},
+  getMessagesFactory: function getMessagesFactory() {}
 };
 exports["default"] = _default;

package/server/WebContentUtil/index.d.ts

@@ -457,6 +457,52 @@ export interface WebContentUtil {
    * @since Sitevision 3.6
    */
   resolveToResourceURL(aNode: Node, aUnresolvedURL: String | string): string;
+
+  /**
+   * Removes the page content of the first root layout for a sv:page, sv:article or a sv:template.
+   *
+   *  <p>
+   *     Content of the <strong>first</strong> root layout available on the node will be removed.
+   *     Use {@link #removeAllContent(Node, String)} instead to specify a specific root layout.
+   *  </p>
+   *
+   *  <p>
+   *     Current user must have effective WRITE permission to mutate the node or a  <code>ConstraintViolationException</code> is thrown.
+   *  </p>
+   *
+   *  <p>
+   *     <em>This method is typically called to clear all content before adding new content via {@link #updateContent(Node, String)}</em>
+   *  </p>
+   * @param aPageNode the node that will be altered, typically a node with primary node type sv:page or sv:article.&#xA; May not be null and may not be the site page
+   * @throws NullPointerException if aPageNode is null
+   * @throws IllegalArgumentException if aPageNode is of invalid type
+   * @throws ConstraintViolationException if current user is not allowed to alter aPageNode
+   * @throws RepositoryException if something else goes wrong
+   * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
+   * @since Sitevision 2024.03.1
+   */
+  removeAllContent(aPageNode: Node): void;
+
+  /**
+   * Removes the page content of a root layout for a sv:page, sv:article or a sv:template.
+   *
+   *  <p>
+   *     Current user must have effective WRITE permission to mutate the node or a <code>ConstraintViolationException</code> is thrown.
+   *  </p>
+   *
+   *  <p>
+   *     <em>This method is typically called to clear all content before adding new content via {@link #updateContent(Node, Map)}</em>
+   *  </p>
+   * @param aPageNode the node that will be altered, typically a node with primary node type sv:page or sv:article.&#xA; May not be null and may not be the site page
+   * @param aRootLayoutName the name of the root layout of aPageNode to remove content from (e.g. "Mittenspalt")
+   * @throws NullPointerException if aPageNode or aRootLayoutName is null
+   * @throws IllegalArgumentException if aPageNode is of invalid type or if there are no root layout named aRootLayoutName
+   * @throws ConstraintViolationException if current user is not allowed to alter aPageNode
+   * @throws RepositoryException if something else goes wrong
+   * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
+   * @since Sitevision 2024.03.1
+   */
+  removeAllContent(aPageNode: Node, aRootLayoutName: String | string): void;
 }
 
 declare namespace WebContentUtil {}

package/server/WebContentUtil/index.js

@@ -9,6 +9,7 @@ var _default = {
   updateContentWithRawHtml: function updateContentWithRawHtml() {},
   appendContent: function appendContent() {},
   appendContentWithRawHtml: function appendContentWithRawHtml() {},
-  resolveToResourceURL: function resolveToResourceURL() {}
+  resolveToResourceURL: function resolveToResourceURL() {},
+  removeAllContent: function removeAllContent() {}
 };
 exports["default"] = _default;

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

@@ -0,0 +1,91 @@
+import type { Node } from "../../../../../javax/jcr/Node";
+
+import type { Wrapper } from "../../base/Wrapper";
+
+/**
+ * Channel administration interface.
+ *
+ *  <p>
+ *     This wrapper provides methods to update an existing channel (node of type sv:topic).
+ *  </p>
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link MessagesFactory#getChannelWrapper(javax.jcr.Node)}.
+ *     See {@link MessagesFactory} for how to obtain an instance of the MessagesFactory interface.
+ *  </p>
+ * @author Elias Abrache
+ * @since Sitevision 2024.03.01
+ */
+export type ChannelWrapper = Wrapper & {
+  /**
+   * Adds a user identity as member of the wrapped channel.
+   *
+   *  <p>
+   *     Requires enabled Social collaboration, and for the operating user to have a social user identity.
+   *  </p>
+   *
+   *  <p>
+   *     <em>Only non-members will be added</em>, i.e. a user identity that already is a member will be ignored.
+   *     Channels that are <em>archived</em> don't accept any new members.
+   *  </p>
+   *
+   *  <p>
+   *     <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.
+   *  </p>
+   *  <p>
+   *     <em>Private channels</em> require the operating user to have membership.
+   *  </p>
+   * @param aUserIdentity a user identity (or user)
+   * @return true if aUserIdentity was added as member of the wrapped channel, false otherwise.&#xA; false is always returned if aUserIdentity is null or already a member of the wrapped channel.
+   */
+  addMember(aUserIdentity: Node): boolean;
+
+  /**
+   * Removes a member from the wrapped channel.
+   *
+   *  <p>
+   *     <em>Only members can be removed</em>, i.e. a user identity that is a non-member will be ignored.
+   *     Members can not be removed from channels that are <em>archived</em>.
+   *  </p>
+   *
+   *  <p>
+   *     <strong>Permission notes!</strong>
+   *  </p>
+   *  <p>
+   *     <em>Open channels</em> require the operating user to have one of the following:
+   *  </p>
+   *  <ul>
+   *     <li>
+   *        {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_CHANNELS} permission.
+   *     </li>
+   *     <li>
+   *        Be channel administrator (author of the channel).
+   *     </li>
+   *     <li>
+   *        Operating user matches the user identity (i.e. "is yourself").
+   *     </li>
+   *  </ul>
+   *  <p>
+   *     <em>Private channels</em> require the operating user to have one of the following:
+   *  </p>
+   *  <ul>
+   *     <li>
+   *        Membership and the {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_CHANNELS} permission.
+   *     </li>
+   *     <li>
+   *        Be channel administrator (author of the channel).
+   *     </li>
+   *     <li>
+   *        Operating user matches the user identity (i.e. "is yourself").
+   *     </li>
+   *  </ul>
+   * @param aUserIdentity a user identity (or user)
+   * @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;
+};

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

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

package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts

@@ -1199,6 +1199,13 @@ export type NodeTypeUtilConstants = {
    */
   getMARKETPLACE_HEADLESS_CUSTOM_MODULE_TYPE(): string;
 
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#MARKETPLACE_WIDGET_CUSTOM_MODULE_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#MARKETPLACE_WIDGET_CUSTOM_MODULE_TYPE}
+   * @since Sitevision 2024.02.1
+   */
+  getMARKETPLACE_WIDGET_CUSTOM_MODULE_TYPE(): string;
+
   /**
    * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#RESPONSIVE_BREAKPOINT_REPOSITORY_TYPE}.
    * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#RESPONSIVE_BREAKPOINT_REPOSITORY_TYPE}
@@ -1303,4 +1310,18 @@ export type NodeTypeUtilConstants = {
    * @since Sitevision 2023.09.2
    */
   getWORK_STATUS_TEMPLATE_REPOSITORY_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#DASHBOARD_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#DASHBOARD_TYPE}
+   * @since Sitevision 2024.02.1
+   */
+  getDASHBOARD_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#WIDGET_CUSTOM_MODULE_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#WIDGET_CUSTOM_MODULE_TYPE}
+   * @since Sitevision 2024.02.1
+   */
+  getWIDGET_CUSTOM_MODULE_TYPE(): string;
 };

package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js

@@ -179,6 +179,7 @@ var _default = {
   getUSER_FIELD_REPOSITORY_TYPE: function getUSER_FIELD_REPOSITORY_TYPE() {},
   getMARKETPLACE_CUSTOM_MODULE_TYPE: function getMARKETPLACE_CUSTOM_MODULE_TYPE() {},
   getMARKETPLACE_HEADLESS_CUSTOM_MODULE_TYPE: function getMARKETPLACE_HEADLESS_CUSTOM_MODULE_TYPE() {},
+  getMARKETPLACE_WIDGET_CUSTOM_MODULE_TYPE: function getMARKETPLACE_WIDGET_CUSTOM_MODULE_TYPE() {},
   getRESPONSIVE_BREAKPOINT_REPOSITORY_TYPE: function getRESPONSIVE_BREAKPOINT_REPOSITORY_TYPE() {},
   getTOPIC_REPOSITORY_TYPE: function getTOPIC_REPOSITORY_TYPE() {},
   getTOPIC_TYPE: function getTOPIC_TYPE() {},
@@ -193,6 +194,8 @@ var _default = {
   getOAUTH2_CONFIGURATION_TYPE: function getOAUTH2_CONFIGURATION_TYPE() {},
   getWORK_STATUS_TYPE: function getWORK_STATUS_TYPE() {},
   getWORK_STATUS_TEMPLATE_TYPE: function getWORK_STATUS_TEMPLATE_TYPE() {},
-  getWORK_STATUS_TEMPLATE_REPOSITORY_TYPE: function getWORK_STATUS_TEMPLATE_REPOSITORY_TYPE() {}
+  getWORK_STATUS_TEMPLATE_REPOSITORY_TYPE: function getWORK_STATUS_TEMPLATE_REPOSITORY_TYPE() {},
+  getDASHBOARD_TYPE: function getDASHBOARD_TYPE() {},
+  getWIDGET_CUSTOM_MODULE_TYPE: function getWIDGET_CUSTOM_MODULE_TYPE() {}
 };
 exports["default"] = _default;