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

package/server/PermissionUtil/index.d.ts

@@ -1,5 +1,4 @@
 import Node from "../../hidden/javax/jcr/Node";
-import PermissionUtil_Permission from "../PermissionUtil_Permission";
 
 /**
  * Checks if a non-authenticated user has read permission on current page.
@@ -345,7 +344,7 @@ export function hasCreateFolderPermission(
  * @see #hasPermission(Node, Node, Permission)
  * @since Sitevision 3.6
  */
-export function hasPermission(aPermission: Permission): boolean;
+export function hasPermission(aPermission: unknown): boolean;
 
 /**
  * Checks if current user has certain permissions on current page.
@@ -371,7 +370,7 @@ export function hasPermission(aPermission: Permission): boolean;
  * @see #hasPermissions(Node, Node, Permission...)
  * @since Sitevision 3.6
  */
-export function hasPermissions(aPermissions: Permission): boolean;
+export function hasPermissions(aPermissions: unknown): boolean;
 
 /**
  * Checks if current user has certain permission on a certain tree node.
@@ -382,10 +381,7 @@ export function hasPermissions(aPermissions: Permission): boolean;
  * @see #hasPermission(Node, Node, Permission)
  * @since Sitevision 3.6
  */
-export function hasPermission(
-  aTreeNode: Node,
-  aPermission: Permission
-): boolean;
+export function hasPermission(aTreeNode: Node, aPermission: unknown): boolean;
 
 /**
  * Checks if current user has certain permissions on a certain tree node.
@@ -396,10 +392,7 @@ export function hasPermission(
  * @see #hasPermissions(Node, Node, Permission...)
  * @since Sitevision 3.6
  */
-export function hasPermissions(
-  aTreeNode: Node,
-  aPermissions: Permission
-): boolean;
+export function hasPermissions(aTreeNode: Node, aPermissions: unknown): boolean;
 
 /**
  * Checks if a certain user has a certain permission on a certain tree node.
@@ -414,7 +407,7 @@ export function hasPermissions(
 export function hasPermission(
   aTreeNode: Node,
   aUserNode: Node,
-  aPermission: Permission
+  aPermission: unknown
 ): boolean;
 
 /**
@@ -430,7 +423,7 @@ export function hasPermission(
 export function hasPermissions(
   aTreeNode: Node,
   aUserNode: Node,
-  aPermissions: Permission
+  aPermissions: unknown
 ): boolean;
 
 /**
@@ -439,195 +432,11 @@ export function hasPermissions(
  * <p>
  *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPermissionUtil()}.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Checks if a non-authenticated user has read permission on current page.
- *
- * <p>
- *    This is a convenience method for {@link #hasAnonymousReadPermission(Node)} that uses PortletContextUtil to get
- *    {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentPage() current page}.
- * </p>
- * <p>
- *    <em>
- *       <strong>Note!</strong> RESTApps has no "current page" concept whatsoever.
- *       A RESTApp should therefore typically never use any convenience method that relies on "current page".
- *       This method uses the {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getSitePage() site page}
- *       as "current page" for best effort when invoked from a RESTApp. Beware of unexpected results and also note
- *       that RESTApps has its own complementary restrictions (e.g. only some users can call certain http methods,
- *       incoming http requests can be completely blocked etc).
- *    </em>
- * </p>Checks if a non-authenticated user has read permission on a certain tree node.Checks if current user has read permission on current page.
- *
- * <p>
- *    This is a convenience method for {@link #hasReadPermission(Node, Node)} that uses PortletContextUtil to get
- *    {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentPage() current page} and
- *    {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser() current user}.
  * </p>
- * <p>
- *    <em>
- *       <strong>Note!</strong> RESTApps has no "current page" concept whatsoever.
- *       A RESTApp should therefore typically never use any convenience method that relies on "current page".
- *       This method uses the {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getSitePage() site page}
- *       as "current page" for best effort when invoked from a RESTApp. Beware of unexpected results and also note
- *       that RESTApps has its own complementary restrictions (e.g. only some users can call certain http methods,
- *       incoming http requests can be completely blocked etc).
- *    </em>
- * </p>Checks if a certain user has read permission on a certain tree node.Checks if current user has write permission on current page.
- *
- * <p>
- *    This is a convenience method for {@link #hasWritePermission(Node, Node)} that uses PortletContextUtil to get
- *    {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentPage() current page} and
- *    {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser() current user}.
- * </p>
- * <p>
- *    <em>
- *       <strong>Note!</strong> RESTApps has no "current page" concept whatsoever.
- *       A RESTApp should therefore typically never use any convenience method that relies on "current page".
- *       This method uses the {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getSitePage() site page}
- *       as "current page" for best effort when invoked from a RESTApp. Beware of unexpected results and also note
- *       that RESTApps has its own complementary restrictions (e.g. only some users can call certain http methods,
- *       incoming http requests can be completely blocked etc).
- *    </em>
- * </p>Checks if a certain user has write permission on a certain tree node.Checks if a certain user has <em>effective</em> write permission on a certain tree node.
- *
- * <p>
- *    This is a extended version of {@link #hasWritePermission(Node, Node)} that delivers a more accurate runtime result.
- * </p>
- * <p>
- *    Even though a User strict formally has {@link Permission#WRITE} permission on a Node, some additional state might
- *    in practice prohibit actual write operations anyway. This method also checks such cases. For example:
- * </p>
- * <ul>
- *    <li>
- *       The Node is <strong>Locked</strong>
- *       <ul>
- *           <li><em>This method will return false if the Node is locked by another User</em></li>
- *       </ul>
- *    </li>
- *    <li>
- *       The Node is part of a <strong>Publishing project</strong>
- *       <ul>
- *          <li><em>This method will return false if the Node is in the "ready/done" state</em></li>
- *          <li>
- *             <em>This method will return false if the User isn't a project member or have {@link Permission#MANAGE_PUBLISHING_PROJECT}</em>
- *          </li>
- *       </ul>
- *    </li>
- *    <li>
- *       The Node is in a pending <strong>Publishing flow</strong>
- *       <ul>
- *           <li><em>This method will return false</em></li>
- *       </ul>
- *    </li>
- * </ul>
- * <p>
- *    <em>
- *       <strong>Note!</strong> This method is more reliable than its static "hasWritePermission" sibling, but in a runtime environment anything
- *       can happen at any given time! Hence, even if this method returns true - there are absolutely no guarantee that the true state will remain
- *       when an actual mutating operation is performed shortly after.
- *    </em>
- * </p>Checks if a certain user has publish permission on a certain page tree node.Checks if a certain user has <em>effective</em> publish permission on a certain page tree node.
- *
- * <p>
- *    This is a extended version of {@link #hasPublishPermission(Node, Node)} that delivers a more accurate runtime result.
- * </p>
- * <p>
- *    Even though a User strict formally has {@link Permission#PUBLISH} permission on a Node, some additional state might
- *    in practice prohibit actual publish operations anyway. This method also checks such cases. For example:
- * </p>
- * <ul>
- *    <li>
- *       The Node is <strong>Locked</strong>
- *       <ul>
- *           <li><em>This method will return false if the Node is locked by another User</em></li>
- *       </ul>
- *    </li>
- *    <li>
- *       The Node is part of a <strong>Publishing project</strong>
- *       <ul>
- *          <li><em>This method will return false</em></li>
- *       </ul>
- *    </li>
- *    <li>
- *       The Node is in a pending <strong>Publishing flow</strong>
- *       <ul>
- *           <li><em>This method will return false</em></li>
- *       </ul>
- *    </li>
- * </ul>
- * <p>
- *    <em>
- *       <strong>Note!</strong> This method is more reliable than its static "hasPublishPermission" sibling, but in a runtime environment anything
- *       can happen at any given time! Hence, even if this method returns true - there are absolutely no guarantee that the true state will remain
- *       when an actual publish operation is performed shortly after.
- *    </em>
- * </p>Checks if a certain user has write subscription permission on a certain page tree node.Checks if a certain user has delete permission on a certain tree node.Checks if a certain user has <em>effective</em> delete permission on a certain tree node.
- *
- * <p>
- *    This is a extended version of {@link #hasDeletePermission(Node, Node)} that delivers a more accurate runtime result.
- * </p>
- * <p>
- *    Even though a User strict formally has {@link Permission#DELETE} and {@link Permission#WRITE} permission on a Node, some additional
- *    state might in practice prohibit actual delete operations anyway. This method also checks such cases. For example:
- * </p>
- * <ul>
- *    <li>
- *       The Node is part of a <strong>Publishing project</strong>
- *       <ul>
- *          <li><em>This method will return false if the Node is in the "ready/done" state</em></li>
- *          <li>
- *             <em>This method will return false if the User isn't a project member or have {@link Permission#MANAGE_PUBLISHING_PROJECT}</em>
- *          </li>
- *       </ul>
- *    </li>
- *    <li>
- *       The Node is in a pending <strong>Publishing flow</strong>
- *       <ul>
- *           <li><em>This method will return false</em></li>
- *       </ul>
- *    </li>
- * </ul>
- * <p>
- *    <em>
- *       <strong>Note!</strong> This method is more reliable than its static "hasDeletePermission" sibling, but in a runtime environment anything
- *       can happen at any given time! Hence, even if this method returns true - there are absolutely no guarantee that the true state will remain
- *       when an actual delete operation is performed shortly after.
- *    </em>
- * </p>Checks if a certain user has create page permission on a certain page tree node.Checks if a certain user has create article permission on a certain page tree node.Checks if a certain user has create archive permission on a certain page tree node.Checks if a certain user has create folder permission on a certain tree node.Checks if current user has a certain permission on current page.
- *
- * <p>
- *    This is a convenience method for {@link #hasPermission(Node, Node, Permission)} that uses PortletContextUtil to get
- *    {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentPage() current page} and
- *    {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser() current user}.
- * </p>
- * <p>
- *    <em>
- *       <strong>Note!</strong> RESTApps has no "current page" concept whatsoever.
- *       A RESTApp should therefore typically never use any convenience method that relies on "current page".
- *       This method uses the {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getSitePage() site page}
- *       as "current page" for best effort when invoked from a RESTApp. Beware of unexpected results and also note
- *       that RESTApps has its own complementary restrictions (e.g. only some users can call certain http methods,
- *       incoming http requests can be completely blocked etc).
- *    </em>
- * </p>Checks if current user has certain permissions on current page.
- *
- * <p>
- *    This is a convenience method for {@link #hasPermissions(Node, Node, Permission...)} that uses PortletContextUtil to get
- *    {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentPage() current page} and
- *    {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser() current user}.
- * </p>
- * <p>
- *    <em>
- *       <strong>Note!</strong> RESTApps has no "current page" concept whatsoever.
- *       A RESTApp should therefore typically never use any convenience method that relies on "current page".
- *       This method uses the {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getSitePage() site page}
- *       as "current page" for best effort when invoked from a RESTApp. Beware of unexpected results and also note
- *       that RESTApps has its own complementary restrictions (e.g. only some users can call certain http methods,
- *       incoming http requests can be completely blocked etc).
- *    </em>
- * </p>Checks if current user has certain permission on a certain tree node.Checks if current user has certain permissions on a certain tree node.Checks if a certain user has a certain permission on a certain tree node.Checks if a certain user has certain permissions on a certain tree node.
  * @author Magnus Lövgren
  * @since Sitevision 2.6
  */
-declare namespace PermissionUtil {
+declare namespace permissionUtil {
   export {
     hasAnonymousReadPermission,
     hasReadPermission,
@@ -647,4 +456,4 @@ declare namespace PermissionUtil {
   };
 }
 
-export default PermissionUtil;
+export default permissionUtil;

package/server/PermissionUtil/index.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  hasAnonymousReadPermission: function hasAnonymousReadPermission() {},
+  hasReadPermission: function hasReadPermission() {},
+  hasWritePermission: function hasWritePermission() {},
+  hasEffectiveWritePermission: function hasEffectiveWritePermission() {},
+  hasPublishPermission: function hasPublishPermission() {},
+  hasEffectivePublishPermission: function hasEffectivePublishPermission() {},
+  hasWriteSubscriptionPermission: function hasWriteSubscriptionPermission() {},
+  hasDeletePermission: function hasDeletePermission() {},
+  hasEffectiveDeletePermission: function hasEffectiveDeletePermission() {},
+  hasCreatePagePermission: function hasCreatePagePermission() {},
+  hasCreateArticlePermission: function hasCreateArticlePermission() {},
+  hasCreateArchivePermission: function hasCreateArchivePermission() {},
+  hasCreateFolderPermission: function hasCreateFolderPermission() {},
+  hasPermission: function hasPermission() {},
+  hasPermissions: function hasPermissions() {}
+};
+exports["default"] = _default;

package/server/PortletContextUtil/index.d.ts

@@ -103,33 +103,12 @@ export function getNonce(): string;
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link senselogic.sitevision.api.Utils#getPortletContextUtil()}.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Gets current page (i.e. the page node for the currently executing portlet).Gets current portlet.Gets current module element (module element draft or module element).Gets current Locale.Gets current user.Gets current user identity.Gets current decorated node (applicable during render of a sv:decorationTemplate).
- *
- * <p>
- *    This method returns the "decorated" node (typically a sv:portlet or sv:layout) during render of a sv:decorationTemplate.
- *    In other words - it returns the node that is decorated with the template-based decoration that is now rendering.
- * </p>Gets current version.Gets a unique namespace for the specific portlet that is rendering.
- *
- * <p>
- *    The namespace is based on the prefix (aPrefix) and the current portlet's id.
- *    If you have two portlets of same type on the same page, the namespaces will differ. This can for instance be very useful when you
- *    connect a &lt;label&gt; with an &lt;input&gt;. Example in Velocity:
- * </p>
- * <pre><code>
- *   #set ($portletContextUtil = $sitevisionUtils.portletContextUtil)
- *   ...
- *   #set ($ns = $portletContextUtil.getPortletNamespace('name'))
- *   &lt;label for="$ns"&gt;Name: &lt;/label&gt;&lt;input id="$ns" name="name" type="text" /&gt;</code></pre>
- * The namespace generated in the above example (i.e. <code>$ns</code>) could be something like: <code>name12_2b9561c511855e0ab91800015</code>Gets a unique nonce for this request.
- *
- * <p>
- *    The nonce should be used for all client-side inline javascript (e.g. <code>&lt;script nonce="..."&gt; ... &lt;script&gt;</code>).
- *    If not specified, the script might be blocked and ignored by the client/browser due to the content security policy settings of the page
- *    (i.e. typically when the CSP has no "unsafe-inline" specified).
  * </p>The offline version (i.e. the version used when editing in the Sitevision editor) markerThe online version (i.e. the published version that visitors can access) marker
  * @author Magnus Lövgren
+ * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}
+ * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
  */
-declare namespace PortletContextUtil {
+declare namespace portletContextUtil {
   export {
     getCurrentPage,
     getCurrentPortlet,
@@ -144,4 +123,4 @@ declare namespace PortletContextUtil {
   };
 }
 
-export default PortletContextUtil;
+export default portletContextUtil;

package/server/PortletContextUtil/index.js

@@ -5,14 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
-  getCurrentDecoratedNode: function getCurrentDecoratedNode() {},
-  getCurrentLocale: function getCurrentLocale() {},
-  getCurrentModuleElement: function getCurrentModuleElement() {},
   getCurrentPage: function getCurrentPage() {},
   getCurrentPortlet: function getCurrentPortlet() {},
+  getCurrentModuleElement: function getCurrentModuleElement() {},
+  getCurrentLocale: function getCurrentLocale() {},
   getCurrentUser: function getCurrentUser() {},
   getCurrentUserIdentity: function getCurrentUserIdentity() {},
-  getNonce: function getNonce() {},
-  getPortletNamespace: function getPortletNamespace() {}
+  getCurrentDecoratedNode: function getCurrentDecoratedNode() {},
+  getCurrentVersion: function getCurrentVersion() {},
+  getPortletNamespace: function getPortletNamespace() {},
+  getNonce: function getNonce() {}
 };
 exports["default"] = _default;

package/server/PortletUtil/index.d.ts

@@ -24,17 +24,12 @@ export function getPortletPreferences(
  * <p>
  * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPortletUtil()}.
  * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p><p>Extracts the user specific <code>PortletPreferences</code> for the specified portlet.
- * This method is a complement to the accessor provided by <code>PortletRequest.getPreferences</code>
- * which returns the <code>PortletPreferences</code> for the current user.</p>
- *
- * <p>Note that this method only returns the portlet preferences that are stored. Any
- * local modifications that has not yet been stored will be ignored.</p>The personal portlet preferences type.
+ * </p>The personal portlet preferences type.
  * @author Mikael Wikblom
  * @since Sitevision 2.6_06
  */
-declare namespace PortletUtil {
+declare namespace portletUtil {
   export { getPortletPreferences };
 }
 
-export default PortletUtil;
+export default portletUtil;

package/server/PortletUtil/index.js

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

package/server/PrincipalUtil/index.d.ts

@@ -27,7 +27,7 @@ export function getVirtualGroupByName(aName: string): Node;
  * @return a list of virtual groups wrapped in JCR nodes, or an empty list of none exists
  * @since Sitevision 3.0
  */
-export function getVirtualGroupsByName(aNames: unknown[]): unknown[];
+export function getVirtualGroupsByName(aNames: unknown): unknown;
 
 /**
  * <p>Principal utility interface.</p>
@@ -35,17 +35,12 @@ export function getVirtualGroupsByName(aNames: unknown[]): unknown[];
  * <p>
  * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPrincipalUtil()}.
  * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Perform work during the login phase as a specified user.
- *
- * <p>
- *    <strong>Note!</strong> This method should <em>only</em> be used during the login phase (i.e. in a JAAS login module).
- *    Other usages will throw an <code>IllegalStateException</code>.
- * </p>Provides access to a virtual group wrapped as a JCR node given the group name.Provides access to virtual groups wrapped as a JCR node given the group name.
+ * </p>
  * @author Mikael Wikblom
  * @since Sitevision 2.6.1_06
  */
-declare namespace PrincipalUtil {
+declare namespace principalUtil {
   export { doAsDuringLogin, getVirtualGroupByName, getVirtualGroupsByName };
 }
 
-export default PrincipalUtil;
+export default principalUtil;

package/server/PrincipalUtil/index.js

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

package/server/Properties/index.d.ts

@@ -164,35 +164,13 @@ export function getArrayEscaped(
  *       In other server-side scripting contexts (e.g. the Script module) you would typically use {@link #getEscaped(Object, String...)} or
  *       {@link #getArrayEscaped(Object, String...)} and output the (already) escaped value using Velocity (e.g. <code>$theEscapedValue</code>).
  *    </li>
- * </ul>Gets named properties from a given Node-resolvable object.
- *
- * <p>
- *    <em>See code examples in the interface description above.</em>
- * </p>Gets escaped named properties from a given Node-resolvable object.
- *
- * <p>
- *    This method is equivalent with {@link #get(Object, String...)} except that all string values will be escaped.
- * </p>Processes an iterable object and returns an array of named properties for each Node-resolvable object that is iterated.
- *
- * <p>
- *    This method is conceptually equivalent with the {@link #get(Object, String...) get} method but
- *    the core functionality of this method is to process something that can be iterated in order to handle <em>multiple</em> nodes
- *    and deliver properties for them as an array.
- * </p>
- *
- * <p>
- *    <em>See code examples in the interface description above.</em>
- * </p>Processes an iterable object and returns an array of escaped named properties for each Node-resolvable object that is iterated.
- *
- * <p>
- *    This method is equivalent with {@link #getArray(Object, String...)} except that all string values will be escaped.
- * </p>
+ * </ul>
  * @param <T> native script value
  * @author Magnus Lövgren
  * @since Sitevision 4.5.2
  */
-declare namespace Properties {
+declare namespace properties {
   export { get, getEscaped, getArray, getArrayEscaped };
 }
 
-export default Properties;
+export default properties;

package/server/Properties/index.js

@@ -5,17 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
-  get: function get() {
-    return {};
-  },
-  getEscaped: function getEscaped() {
-    return {};
-  },
-  getArray: function getArray() {
-    return [];
-  },
-  getArrayEscaped: function getArrayEscaped() {
-    return [];
-  }
+  get: function get() {},
+  getEscaped: function getEscaped() {},
+  getArray: function getArray() {},
+  getArrayEscaped: function getArrayEscaped() {}
 };
 exports["default"] = _default;