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

package/server/BuddyIconRenderer/index.d.ts

@@ -1,6 +1,4 @@
-import BuddyIconRenderer_BuddyIconSize from "../BuddyIconRenderer_BuddyIconSize";
 import Node from "../../hidden/javax/jcr/Node";
-import BuddyIconRenderer_BuddyIconInfo from "../../hidden/senselogic/sitevision/api/render/BuddyIconRenderer/BuddyIconInfo";
 
 /**
  * Sets the size for rendered buddy icons.
@@ -8,7 +6,7 @@ import BuddyIconRenderer_BuddyIconInfo from "../../hidden/senselogic/sitevision/
  * <p>Default is <code>BuddyIconSize.SMALL</code></p>
  * @param aBuddyIconSize the icon size
  */
-export function setBuddyIconSize(aBuddyIconSize: BuddyIconSize): void;
+export function setBuddyIconSize(aBuddyIconSize: unknown): void;
 
 /**
  * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.SMALL)</code>
@@ -107,7 +105,7 @@ export function isRenderable(aNode: Node): boolean;
  * @return the BuddyIconInfo for current state, is never null.
  * @since Sitevision 8.2
  */
-export function getBuddyIconInfo(): BuddyIconInfo;
+export function getBuddyIconInfo(): unknown;
 
 /**
  * Builds a html string based on current state.
@@ -178,49 +176,11 @@ export function render(): string;
  *     #end
  *   #end
  *   &lt;/ul&gt;
- * </code></pre>Sets the size for rendered buddy icons.
- *
- * <p>Default is <code>BuddyIconSize.SMALL</code></p>Utility method for executing <code>setBuddyIconSize(BuddyIconSize.SMALL)</code>Utility method for executing <code>setBuddyIconSize(BuddyIconSize.LARGE)</code>Utility method for executing <code>setBuddyIconSize(BuddyIconSize.X_LARGE)</code>Whether or not rendered buddy icons should be linked.
- *
- * <p>Default is <code>true</code></p>Utility method for executing <code>setLinkBuddyIcon(false)</code>Utility method for executing <code>setLinkBuddyIcon(true)</code>Updates the renderer with a new buddy icon supported node.
- *
- * <p>
- *    If <code>aBuddyIconNode</code> is not a type that can be represented by a buddy icon, the argument will be considered as <code>null</code>,
- *    i.e. the renderer will not have any renderable node in subsequent render execution.
- * </p>Whether or not this renderer contains a node that can be rendered.Helper method to check if a certain node can be rendered as a buddy icon.
- *
- * <p>
- *    Nodes with the following primary node types are potentially renderable:
- * </p>
- * <ul>
- *    <li><code>sv:userIdentity</code></li>
- *    <li><code>sv:user</code> <em>(non-anonymous)</em> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
- *    <li><code>sv:simpleUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
- *    <li style="margin-bottom:1em"><code>sv:systemUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
- *    <li><code>sv:collaborationGroup</code></li>
- *    <li><code>sv:collaborationGroupPage</code> &raquo; <em>will be renderable if a sv:collaborationGroup can be extracted</em></li>
- * </ul>BuddyIconInfo for current state.
- *
- * <p>
- *    <em>
- *       The data this method provides is used by the {@link #render()} method.
- *       The intent of this method is to facilitate custom buddy icon rendering solutions.
- *       See {@link BuddyIconInfo} for such example.
- *    </em>
- * </p>
- *
- * <p>
- *    Note! Returned BuddyIconInfo object is never null but its <code>uri</code> will potentially be null and its
- *    <code>width</code>/<code>height</code> might be zero.
- *    Typically when this renderer has no valid/renderable node loaded, see {@link #isLoaded()}.
- * </p>Builds a html string based on current state.
- *
- * <strong>Size note!</strong> Profile images will never be upscaled. If a buddy icon size is larger than the actual size of the profile image,
- * the image will be rendered with the largest possible buddy icon size.
+ * </code></pre>
  * @author Magnus Lövgren
  * @since Sitevision 3.5.3
  */
-declare namespace BuddyIconRenderer {
+declare namespace buddyIconRenderer {
   export {
     setBuddyIconSize,
     forceUseSmallBuddyIconSize,
@@ -237,4 +197,4 @@ declare namespace BuddyIconRenderer {
   };
 }
 
-export default BuddyIconRenderer;
+export default buddyIconRenderer;

package/server/BuddyIconRenderer/index.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  setBuddyIconSize: function setBuddyIconSize() {},
+  forceUseSmallBuddyIconSize: function forceUseSmallBuddyIconSize() {},
+  forceUseLargeBuddyIconSize: function forceUseLargeBuddyIconSize() {},
+  forceUseXLargeBuddyIconSize: function forceUseXLargeBuddyIconSize() {},
+  setLinkBuddyIcon: function setLinkBuddyIcon() {},
+  clearUseLinkBuddyIcon: function clearUseLinkBuddyIcon() {},
+  forceUseLinkBuddyIcon: function forceUseLinkBuddyIcon() {},
+  update: function update() {},
+  isLoaded: function isLoaded() {},
+  isRenderable: function isRenderable() {},
+  getBuddyIconInfo: function getBuddyIconInfo() {},
+  render: function render() {}
+};
+exports["default"] = _default;

package/server/ClientUtil/index.d.ts

@@ -15,12 +15,12 @@ export function getClientAddress(): string;
  * <p>
  * <em>Tip!</em> If you want to check if current client is a mobile device, you would typically use
  * {@link senselogic.sitevision.api.device.DeviceUtil}.
- * </p>Gets the Internet Protocol (IP) address of the client (or last proxy) that initiated currently executing request.
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 2.6_02
  */
-declare namespace ClientUtil {
+declare namespace clientUtil {
   export { getClientAddress };
 }
 
-export default ClientUtil;
+export default clientUtil;

package/server/CollaborationFactory/index.d.ts

@@ -41,11 +41,11 @@ export function getCollaborationGroupTemplateUtil(): CollaborationGroupTemplateU
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link senselogic.sitevision.api.Utils#getCollaborationFactory()}.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Gets a collaboration group wrapper for a specified collaboration group.Gets an instance of a collaboration group utility classGets an instance of a collaboration group folder utility classGets an instance of a collaboration group template utility class
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace CollaborationFactory {
+declare namespace collaborationFactory {
   export {
     getCollaborationGroupWrapper,
     getCollaborationGroupUtil,
@@ -54,4 +54,4 @@ declare namespace CollaborationFactory {
   };
 }
 
-export default CollaborationFactory;
+export default collaborationFactory;

package/server/CollaborationFactory/index.js

@@ -4,5 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {};
+var _default = {
+  getCollaborationGroupWrapper: function getCollaborationGroupWrapper() {},
+  getCollaborationGroupUtil: function getCollaborationGroupUtil() {},
+  getCollaborationGroupFolderUtil: function getCollaborationGroupFolderUtil() {},
+  getCollaborationGroupTemplateUtil: function getCollaborationGroupTemplateUtil() {}
+};
 exports["default"] = _default;

package/server/CollaborationGroupFolderUtil/index.d.ts

@@ -31,17 +31,12 @@ export function containsCollaborationGroup(
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link CollaborationFactory#getCollaborationGroupFolderUtil()}.
  *    See {@link CollaborationFactory} for how to obtain an instance of the <code>CollaborationFactory</code> interface.
- * </p>Gets the default collaboration group folder.
- *
- * <p>
- *    The <em>default collaboration group folder</em> is the folder where new collaboration groups
- *    (i.e. collaboration group pages) are created by default.
- * </p>Whether or not a collaboration group folder already contains a named collaboration group.
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.4
  */
-declare namespace CollaborationGroupFolderUtil {
+declare namespace collaborationGroupFolderUtil {
   export { getDefaultCollaborationGroupFolder, containsCollaborationGroup };
 }
 
-export default CollaborationGroupFolderUtil;
+export default collaborationGroupFolderUtil;

package/server/CollaborationGroupFolderUtil/index.js

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

package/server/CollaborationGroupTemplateUtil/index.d.ts

@@ -40,7 +40,7 @@ export function getCollaborationGroupTemplateByName(
  * @return all collaboration group templates, or empty list if there are no accessible collaboration group templates.
  * @since Sitevision 4.1
  */
-export function getCollaborationGroupTemplates(): unknown[];
+export function getCollaborationGroupTemplates(): unknown;
 
 /**
  * Collaboration group template utility interface that handles nodes with primary node type <code>sv:collaborationGroupTemplate</code>.
@@ -49,31 +49,12 @@ export function getCollaborationGroupTemplates(): unknown[];
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link CollaborationFactory#getCollaborationGroupTemplateUtil()}.
  *    See {@link CollaborationFactory} for how to obtain an instance of the <code>CollaborationFactory</code> interface.
- * </p>Gets the default collaboration group template.
- *
- * <p>
- *    The <em>default collaboration group template</em> is the template that are used by default to create new
- *    collaboration groups (i.e. collaboration group pages).
- * </p>
- * <p>
- *    <em>Permission note!</em> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
- *    on default collaboration group template.
- * </p>Gets the first found collaboration group template that matches a given name.
- *
- * <p>
- *    <em>Permission note!</em> Only collaboration group templates that current user has
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on will be considered.
- * </p>Gets all collaboration group templates.
- *
- * <p>
- *    <em>Permission note!</em> The list will only contain collaboration group templates that current user has
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on.
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.4
  * @see senselogic.sitevision.api.resource.TemplateUtil
  */
-declare namespace CollaborationGroupTemplateUtil {
+declare namespace collaborationGroupTemplateUtil {
   export {
     getDefaultCollaborationGroupTemplate,
     getCollaborationGroupTemplateByName,
@@ -81,4 +62,4 @@ declare namespace CollaborationGroupTemplateUtil {
   };
 }
 
-export default CollaborationGroupTemplateUtil;
+export default collaborationGroupTemplateUtil;

package/server/CollaborationGroupTemplateUtil/index.js

@@ -5,14 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
-  getCollaborationGroupTemplateByName: function getCollaborationGroupTemplateByName() {
-    return {};
-  },
-  getCollaborationGroupTemplates: function getCollaborationGroupTemplates() {
-    return [];
-  },
-  getCollaborationGroupTemplate: function getCollaborationGroupTemplate() {
-    return {};
-  }
+  getDefaultCollaborationGroupTemplate: function getDefaultCollaborationGroupTemplate() {},
+  getCollaborationGroupTemplateByName: function getCollaborationGroupTemplateByName() {},
+  getCollaborationGroupTemplates: function getCollaborationGroupTemplates() {}
 };
 exports["default"] = _default;

package/server/CollaborationGroupUtil/index.d.ts

@@ -1,5 +1,4 @@
 import Node from "../../hidden/javax/jcr/Node";
-import CollaborationGroupType from "../CollaborationGroupType";
 
 /**
  * Creates an open collaboration group.
@@ -60,7 +59,7 @@ export function createCollaborationGroup(
   aGroupTemplate: Node,
   aGroupFolder: Node,
   aGroupName: string,
-  aGroupType: CollaborationGroupType
+  aGroupType: unknown
 ): Node;
 
 /**
@@ -92,47 +91,12 @@ export function removeCollaborationGroup(aCollaborationGroup: Node): boolean;
  * <p>
  *    An instance of the Sitevision class implementing this interface can be obtained via {@link CollaborationFactory#getCollaborationGroupUtil()}.
  *    See {@link CollaborationFactory} for how to obtain an instance of the <code>CollaborationFactory</code> interface.
- * </p>Creates an open collaboration group.
- *
- * <p>
- *    <em>
- *       This is a legacy convenience method that delegates to {@link #createCollaborationGroup(Node, Node, String, CollaborationGroupType)}
- *       using {@link CollaborationGroupType#OPEN} as group type.
- *    </em>
- * </p>Creates a collaboration group.
- *
- * <p>
- *    <strong>Permission note!</strong> Current user must have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on <code>aGroupTemplate</code>
- *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_COLLABORATION_GROUP} on <code>aGroupFolder</code>.
- *    In order to create a {@link CollaborationGroupType#CLOSED} collaboration group, current user must also have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_CLOSED_COLLABORATION_GROUP} on <code>aGroupFolder</code>.
- * </p>
- * <p>
- *    <strong>User note!</strong> Current user must have a user identity as it will be the administrator of the created
- *    group. <em>Anonymous</em> users doesn't have a user identity, nor the <em>Indexer</em>, <em>Validator</em> or the <em>Extractor</em>.
- *    In other words: {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUserIdentity()} must be non-<code>null</code>.
- * </p>
- *
- * <p>
- *    <em>Tip!</em> Use {@link CollaborationGroupTemplateUtil} to get a group template,
- *    use {@link CollaborationGroupFolderUtil} to get the default group folder (and perhaps check if the collaboration folder already contains
- *    a collaboration group with specified name). Use {@link CollaborationGroupWrapper} to update the group that is created.
- * </p>Removes a collaboration group.
- *
- * <p>
- *    <em>Note!</em> When a collaboration group (<code>sv:collaborationGroup</code>) is removed,
- *    its collaboration group page (<code>sv:collaborationGroupPage</code>) is moved to the trashcan.
- * </p>
- * <p>
- *    <strong>Permission note!</strong> To remove a collaboration group current user must have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP} on the collaboration group page.
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.4
  */
-declare namespace CollaborationGroupUtil {
+declare namespace collaborationGroupUtil {
   export { createCollaborationGroup, removeCollaborationGroup };
 }
 
-export default CollaborationGroupUtil;
+export default collaborationGroupUtil;

package/server/CollaborationGroupUtil/index.js

@@ -5,11 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
-  createCollaborationGroup: function createCollaborationGroup() {
-    return {};
-  },
-  removeCollaborationGroup: function removeCollaborationGroup() {
-    return true;
-  }
+  createCollaborationGroup: function createCollaborationGroup() {},
+  removeCollaborationGroup: function removeCollaborationGroup() {}
 };
 exports["default"] = _default;