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

package/server/NodeFilterUtil/index.d.ts

@@ -1,4 +1,5 @@
 import Filter from "../../hidden/senselogic/sitevision/api/base/Filter";
+
 import FilterSplit from "../../hidden/senselogic/sitevision/api/base/FilterSplit";
 import CompoundAndFilterBuilder from "../CompoundAndFilterBuilder";
 import CompoundOrFilterBuilder from "../CompoundOrFilterBuilder";
@@ -10,9 +11,9 @@ import CompoundOrFilterBuilder from "../CompoundOrFilterBuilder";
  * @return a list of all nodes of <code>aNodeList</code> that is accepted by <code>aNodeFilter</code>, never <code>null</code>. <code>aNodeList</code> itself is returned if it's empty or if <code>aNodeFilter</code> is <code>null</code>
  */
 export function getFilteredList(
-  aNodeList: unknown[],
+  aNodeList: unknown,
   aNodeFilter: Filter
-): unknown[];
+): unknown;
 
 /**
  * Applies a node filter to a Map with Node values and gets the result.
@@ -22,9 +23,9 @@ export function getFilteredList(
  * @since Sitevision 4.3.1
  */
 export function getFilteredValueMap(
-  aNodeValueMap: Record<unknown, unknown>,
+  aNodeValueMap: unknown,
   aNodeFilter: Filter
-): Record<unknown, unknown>;
+): unknown;
 
 /**
  * Applies a node filter to a Map with Node keys and gets the result.
@@ -34,9 +35,9 @@ export function getFilteredValueMap(
  * @since Sitevision 4.3.1
  */
 export function getFilteredKeyMap(
-  aNodeKeyMap: Record<unknown, unknown>,
+  aNodeKeyMap: unknown,
   aNodeFilter: Filter
-): Record<unknown, unknown>;
+): unknown;
 
 /**
  * Gets the filtering result of a split operation for a collection of nodes with a node filter as divider.
@@ -775,98 +776,11 @@ export function getRangeNestedCalendarPropertyFilter(
  * <p>
  *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getNodeFilterUtil()}.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Applies a node filter to a list and gets the result.Applies a node filter to a Map with Node values and gets the result.Applies a node filter to a Map with Node keys and gets the result.Gets the filtering result of a split operation for a collection of nodes with a node filter as divider.
- *
- * <p>
- *    This method would typically be used instead of {@link #getFilteredList(java.util.List, senselogic.sitevision.api.base.Filter)}
- *    when you are also interested in the nodes that does NOT match the filter.
- * </p>
- *
- * <p>
- *    When nodes are available via a <code>NodeIterator</code>, you would typically use the
- *    {@link senselogic.sitevision.api.node.NodeIteratorUtil#split(javax.jcr.NodeIterator, senselogic.sitevision.api.base.Filter)}
- *    instead!
- * </p>Gets a builder for creating a compound filter that requires that <em>all</em> of the containing filters matches.
- *
- * <p>
- *    The CompoundAndFilterBuilder builds a node filter of multiple filters that are combined using the logical
- *    <em>AND</em> operator.
- * </p>Gets a builder for creating a compound filter that requires that <em>any</em> of the containing filters matches.
- *
- * <p>
- *    The CompoundOrFilterBuilder builds a node filter of multiple filters that are combined using the logical
- *    <em>OR</em> operator.
- * </p>Gets a filter that always matches.Gets a filter that never matches.Gets a filter that matches null nodes.Gets a filter that matches non-null nodes.Gets a filter that inverts the result of another filter.Gets a filter that matches by a specified node identifier.Gets a filter that matches by a specified node identifier prefix.Gets a filter that matches by a specified node identifier suffix.Gets a filter that matches by a specified primary node type.Gets a filter that matches all nodes that has a primary node type that is present in given collection.
- *
- * <p>
- *    This convenience method is conceptually equivalent - but also more efficient - than building a "match any of" filter via
- *    {@link #getCompoundOrFilterBuilder() CompoundOrFilter} with a number of {@link #getPrimaryNodeTypeFilter(String) PrimaryNodeTypeFilters}.
- * </p>Gets a filter that matches all nodes that does not have a primary node type present in given collection.
- *
- * <p>
- *    This convenience method is conceptually equivalent - but also more efficient - than building a "match none of" filter via
- *    {@link #getCompoundOrFilterBuilder() CompoundOrFilter} with a number of {@link #getPrimaryNodeTypeFilter(String) PrimaryNodeTypeFilters}
- *    and a {@link #getInvertedFilter(Filter) InvertedFilter}
- * </p>Gets a filter that matches by the existence of a specified property.Gets a filter that matches by a specified string property.Gets a filter that matches by a specified multi-valued string property.Gets a filter that matches case-insensitive by a specified string property.Gets a filter that matches by the value-starts-with of a specified string property.
- *
- * <p>
- *    <em>The starts-with check is performed using the <code>String.startsWith(String)</code> method.</em>
- * </p>Gets a filter that matches by the value-ends-with of a specified string property.
- *
- * <p>
- *    <em>The ends-with check is performed using the <code>String.endsWith(String)</code> method.</em>
- * </p>Gets a filter that matches by the value-contains of a specified string property.
- *
- * <p>
- *    <em>The contains check is performed using the <code>String.contains(String)</code> method.</em>
- * </p>Gets a filter that matches by the value-contains of a specified multi-valued string property.
- *
- * <p>
- *    <em>The contains check is performed using the <code>String.contains(String)</code> method for each extracted property value.</em>
- * </p>Gets a filter that matches by a regular expression of a specified string property.
- *
- * <p>
- *    <em>The regular expression is compiled to a <code>Pattern</code> and the check is performed using the
- *    <code>matches()</code> method of the <code>Matcher</code> extracted from the compiled pattern via
- *    <code>Pattern.matcher(String)</code>.</em>
- * </p>Gets a filter that matches by a regular expression of a specified multi-valued string property.
- *
- * <p>
- *    <em>The regular expression is compiled to a <code>Pattern</code> and the check for each extracted property value is performed using the
- *    <code>matches()</code> method of the <code>Matcher</code> extracted from the compiled pattern via
- *    <code>Pattern.matcher(String)</code>.</em>
- * </p>Gets a filter that matches by a specified boolean property.Gets a filter that matches by a nested node's specified boolean property.Gets a filter that matches by a specified int property.Gets a filter that matches by the min value of a specified int property.Gets a filter that matches by the max value of a specified int property.Gets a filter that matches by the range of a specified int property.
- *
- * <p>
- *    <em>This is a convenience method that combines the min int filter ({@link #getMinIntPropertyFilter(String, int)})
- *    and the max int filter ({@link #getMinIntPropertyFilter(String, int)}) to check a range for an integer.</em>
- * </p>Gets a filter that matches by a nested node's specified int property.Gets a filter that matches by a nested node's min value of a specified int property.Gets a filter that matches by a nested node's max value of a specified int property.Gets a filter that matches by a nested node's range of a specified int property.
- *
- * <p>
- *    <em>This is a convenience method that combines the nested min int filter ({@link #getMinNestedIntPropertyFilter(String, String, int)})
- *    and the nested max int filter ({@link #getMaxNestedIntPropertyFilter(String, String, int)}) to check a range for an integer.</em>
- * </p>Gets a filter that matches by a specified double property.Gets a filter that matches by a nested node's specified double property.Gets a filter that matches by the min value of a specified double property.Gets a filter that matches by the max value of a specified double property.Gets a filter that matches by the range of a specified double property.
- *
- * <p>
- *    <em>This is a convenience method that combines the min double filter ({@link #getMinDoublePropertyFilter(String, double)})
- *    and the max double filter ({@link #getMaxDoublePropertyFilter(String, double)}) to check a range for a double.</em>
- * </p>Gets a filter that matches by a specified Calendar property.Gets a filter that matches by a nested node's specified Calendar property.Gets a filter that matches by a before value for a specified Calendar property.Gets a filter that matches by a before value of a nested node's specified Calendar property.Gets a filter that matches by an after value for a specified Calendar property.Gets a filter that matches by an after value of a nested node's specified Calendar property.Gets a filter that matches by the between range of a specified Calendar property.
- *
- * <p>
- *    <em>This is a convenience method that combines the after calendar filter
- *    ({@link #getAfterCalendarPropertyFilter(String, java.util.Calendar)})
- *    and the before calendar filter ({@link #getBeforeCalendarPropertyFilter(String, java.util.Calendar)}) to check a range for a Calendar.</em>
- * </p>Gets a filter that matches by the between range of a nested node's specified Calendar property.
- *
- * <p>
- *    <em>This is a convenience method that combines the nested after calendar filter
- *    ({@link #getAfterNestedCalendarPropertyFilter(String, String, java.util.Calendar)}) and the nested before calendar filter
- *    ({@link #getBeforeNestedCalendarPropertyFilter(String, String, java.util.Calendar)}) to check a range for a Calendar.</em>
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */
-declare namespace NodeFilterUtil {
+declare namespace nodeFilterUtil {
   export {
     getFilteredList,
     getFilteredValueMap,
@@ -921,4 +835,4 @@ declare namespace NodeFilterUtil {
   };
 }
 
-export default NodeFilterUtil;
+export default nodeFilterUtil;

package/server/NodeFilterUtil/index.js

@@ -0,0 +1,59 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getFilteredList: function getFilteredList() {},
+  getFilteredValueMap: function getFilteredValueMap() {},
+  getFilteredKeyMap: function getFilteredKeyMap() {},
+  split: function split() {},
+  getCompoundAndFilterBuilder: function getCompoundAndFilterBuilder() {},
+  getCompoundOrFilterBuilder: function getCompoundOrFilterBuilder() {},
+  getAlwaysAcceptFilter: function getAlwaysAcceptFilter() {},
+  getNeverAcceptFilter: function getNeverAcceptFilter() {},
+  getNullFilter: function getNullFilter() {},
+  getNonNullFilter: function getNonNullFilter() {},
+  getInvertedFilter: function getInvertedFilter() {},
+  getIdentifierFilter: function getIdentifierFilter() {},
+  getIdentifierPrefixFilter: function getIdentifierPrefixFilter() {},
+  getIdentifierSuffixFilter: function getIdentifierSuffixFilter() {},
+  getPrimaryNodeTypeFilter: function getPrimaryNodeTypeFilter() {},
+  getAnyOfPrimaryNodeTypesFilter: function getAnyOfPrimaryNodeTypesFilter() {},
+  getNoneOfPrimaryNodeTypesFilter: function getNoneOfPrimaryNodeTypesFilter() {},
+  getHasPropertyFilter: function getHasPropertyFilter() {},
+  getStringPropertyFilter: function getStringPropertyFilter() {},
+  getStringMultiPropertyFilter: function getStringMultiPropertyFilter() {},
+  getIgnoreCaseStringPropertyFilter: function getIgnoreCaseStringPropertyFilter() {},
+  getStartsWithStringPropertyFilter: function getStartsWithStringPropertyFilter() {},
+  getEndsWithStringPropertyFilter: function getEndsWithStringPropertyFilter() {},
+  getContainsStringPropertyFilter: function getContainsStringPropertyFilter() {},
+  getContainsStringMultiPropertyFilter: function getContainsStringMultiPropertyFilter() {},
+  getPatternStringPropertyFilter: function getPatternStringPropertyFilter() {},
+  getPatternStringMultiPropertyFilter: function getPatternStringMultiPropertyFilter() {},
+  getBooleanPropertyFilter: function getBooleanPropertyFilter() {},
+  getNestedBooleanPropertyFilter: function getNestedBooleanPropertyFilter() {},
+  getIntPropertyFilter: function getIntPropertyFilter() {},
+  getMinIntPropertyFilter: function getMinIntPropertyFilter() {},
+  getMaxIntPropertyFilter: function getMaxIntPropertyFilter() {},
+  getRangeIntPropertyFilter: function getRangeIntPropertyFilter() {},
+  getNestedIntPropertyFilter: function getNestedIntPropertyFilter() {},
+  getMinNestedIntPropertyFilter: function getMinNestedIntPropertyFilter() {},
+  getMaxNestedIntPropertyFilter: function getMaxNestedIntPropertyFilter() {},
+  getRangeNestedIntPropertyFilter: function getRangeNestedIntPropertyFilter() {},
+  getDoublePropertyFilter: function getDoublePropertyFilter() {},
+  getNestedDoublePropertyFilter: function getNestedDoublePropertyFilter() {},
+  getMinDoublePropertyFilter: function getMinDoublePropertyFilter() {},
+  getMaxDoublePropertyFilter: function getMaxDoublePropertyFilter() {},
+  getRangeDoublePropertyFilter: function getRangeDoublePropertyFilter() {},
+  getCalendarPropertyFilter: function getCalendarPropertyFilter() {},
+  getNestedCalendarPropertyFilter: function getNestedCalendarPropertyFilter() {},
+  getBeforeCalendarPropertyFilter: function getBeforeCalendarPropertyFilter() {},
+  getBeforeNestedCalendarPropertyFilter: function getBeforeNestedCalendarPropertyFilter() {},
+  getAfterCalendarPropertyFilter: function getAfterCalendarPropertyFilter() {},
+  getAfterNestedCalendarPropertyFilter: function getAfterNestedCalendarPropertyFilter() {},
+  getRangeCalendarPropertyFilter: function getRangeCalendarPropertyFilter() {},
+  getRangeNestedCalendarPropertyFilter: function getRangeNestedCalendarPropertyFilter() {}
+};
+exports["default"] = _default;

package/server/NodeIteratorUtil/index.d.ts

@@ -1,6 +1,8 @@
 import NodeIterator from "../../hidden/javax/jcr/NodeIterator";
 import Filter from "../../hidden/senselogic/sitevision/api/base/Filter";
+
 import Node from "../../hidden/javax/jcr/Node";
+
 import FilterSplit from "../../hidden/senselogic/sitevision/api/base/FilterSplit";
 
 /**
@@ -158,7 +160,7 @@ export function findNodes(
   aNodeIterator: NodeIterator,
   aFilter: Filter,
   aMaxNodesToFind: number
-): unknown[];
+): unknown;
 
 /**
  * Gets a list of all nodes from a node iterator that matches a specified filter.
@@ -174,10 +176,7 @@ export function findNodes(
  * @return a list of nodes that matches <code>aFilter</code>, never <code>null</code>. If <code>aFilter</code> is <code>null</code>, the filter will be ignored (all nodes will be accepted). If <code>aNodeIterator</code> is <code>null</code>, an empty list will be returned.
  * @since Sitevision 3.6.2
  */
-export function findAll(
-  aNodeIterator: NodeIterator,
-  aFilter: Filter
-): unknown[];
+export function findAll(aNodeIterator: NodeIterator, aFilter: Filter): unknown;
 
 /**
  * Gets a list of all nodes of a node iterator.
@@ -197,7 +196,7 @@ export function findAll(
  * @return a list of all nodes provided by <code>aNodeIterator</code>, never <code>null</code>.
  * @since Sitevision 3.6.2
  */
-export function toList(aNodeIterator: NodeIterator): unknown[];
+export function toList(aNodeIterator: NodeIterator): unknown;
 
 /**
  * Gets the filtering result of a split operation for a node iterator with a node filter as divider.
@@ -228,115 +227,10 @@ export function split(
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link senselogic.sitevision.api.Utils#getNodeIteratorUtil()}.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Gets a filtered NodeIterator.
- *
- * <p>
- *    This NodeIterator decorates a NodeIterator with a Filter, i.e. it will only return nodes that matches given filter.
- * </p>
- *
- * <p>
- *    This <strong>server-side Javascript example</strong> demonstrates how to create a node iterator that is very similar to the
- *    {@link #getMenuItems(Node) MenuItems} iterator but this node iterator is not respecting the "visibleInMenus" property.
- * </p>
- * <pre><code>    const nodeFilterUtil = require('NodeFilterUtil');
- *    const nodeIteratorUtil = require('NodeIteratorUtil');
- *    const startNode = ...
- *
- *    const filter = nodeFilterUtil.getAnyOfPrimaryNodeTypesFilter([
- *       'sv:page', 'sv:structurePage', 'sv:article', 'sv:link', 'sv:structureLink', 'sv:collaborationGroupPage'
- *    ]);
- *    const nodes = nodeIteratorUtil.getFilteredNodeIterator(startNode.getNodes(), filter);
- *
- *    while (nodes.hasNext()) {
- *       let node = nodes.nextNode();
- *       ...
- *    }</code></pre>Gets a node iterator via a node identifier.
- *
- * <p>
- *    The purpose of this method is twofold:
- * </p>
- * <ul>
- *    <li>
- *       <em>Convenience.</em> This method combines {@link javax.jcr.Session#getNodeByIdentifier(String)} and {@link Node#getNodes()},
- *       i.e. a shortcut to get an iterator without having to actually lookup/resolve the parent node.
- *    </li>
- *    <li>
- *       <em>Permission workaround.</em> This method does <em>not</em> do any permission checks on the resolved parent Node, i.e.
- *       a shortcut to get an iterator of children where you (potentially) have permission from a parent where you don't.
- *    </li>
- * </ul>Gets an iterator for default menu items (i.e. non-hidden pages, link pages etc. where current user has read permission)Gets an iterator for default menu items via a node identifier.
- *
- * <p>
- *    The purpose of this method is twofold:
- * </p>
- * <ul>
- *    <li>
- *       <em>Convenience.</em> This method combines {@link javax.jcr.Session#getNodeByIdentifier(String)} and {@link #getMenuItems(Node)},
- *       i.e. a shortcut to get a menu iterator without having to actually lookup/resolve the parent node.
- *    </li>
- *    <li>
- *       <em>Permission workaround.</em> This method does <em>not</em> do any permission checks on the resolved parent Node, i.e.
- *       a shortcut to get an iterator of children where you (potentially) have permission from a parent where you don't.
- *    </li>
- * </ul>Gets an iterator for default menu items (i.e. getMenuItems(Node)), including foldersGets an iterator for default menu items (including folders) via a node identifier.
- *
- * <p>
- *    The purpose of this method is twofold:
- * </p>
- * <ul>
- *    <li>
- *       <em>Convenience.</em> This method combines {@link javax.jcr.Session#getNodeByIdentifier(String)} and
- *       {@link #getMenuItemsIncludingFolders(Node)}, i.e. a shortcut to get a menu iterator without having to actually
- *       lookup/resolve the parent node.
- *    </li>
- *    <li>
- *       <em>Permission workaround.</em> This method does <em>not</em> do any permission checks on the resolved parent Node, i.e.
- *       a shortcut to get an iterator of children where you (potentially) have permission from a parent where you don't.
- *    </li>
- * </ul>Gets the first node from a node iterator that matches a specified filter.
- *
- * <p>
- *    <em>Tip!</em> Use {@link senselogic.sitevision.api.node.NodeFilterUtil} to get
- *    an appropriate node filter.
- * </p>Gets a max-sized node list from a node iterator that matches a specified filter.
- *
- * <p>
- *    <em>Tip!</em> Use {@link senselogic.sitevision.api.node.NodeFilterUtil} to get
- *    an appropriate node filter. If the list of nodes should be sorted by a specific property value,
- *    you would typically use {@link senselogic.sitevision.api.node.NodeComparatorUtil}
- *    to get an appropriate <code>Comparator</code>.
- * </p>Gets a list of all nodes from a node iterator that matches a specified filter.
- *
- * <p>
- *    <em>Tip!</em> Use {@link senselogic.sitevision.api.node.NodeFilterUtil} to get
- *    an appropriate node filter. If the list of nodes should be sorted by a specific property value,
- *    you would typically use {@link senselogic.sitevision.api.node.NodeComparatorUtil}
- *    to get an appropriate <code>Comparator</code>.
- * </p>Gets a list of all nodes of a node iterator.
- *
- * <p>
- *    <strong>Note!</strong> This is a convenience method to use <strong>only when you must</strong> get nodes as a list!
- *    The only apparent reason is when you need need to <em>sort</em> the nodes! If you don't, you should use
- *    the <code>NodeIterator</code> instead and do your processing for each node.
- * </p>
- * <p>
- *    <strong>Sorting tip!</strong> When the list of nodes should be sorted by a specific <em>property value</em>,
- *    you would typically use {@link senselogic.sitevision.api.node.NodeComparatorUtil}to get an appropriate
- *    <code>Comparator</code>. The list can then be sorted by <code>Collections.sort(List, Comparator)</code>.
- *    When using Velocity, you must use the non-static class {@link senselogic.sitevision.api.script.factory.CollectionsInstance}.
- * </p>Gets the filtering result of a split operation for a node iterator with a node filter as divider.
- *
- * <p>
- *    This method would typically be used instead of {@link #findAll(javax.jcr.NodeIterator, senselogic.sitevision.api.base.Filter)}
- *    when you are also interested in the nodes that does NOT match the filter.
- * </p>
- * <p>
- *    <em>Note!</em> If <code>aFilter</code> is <code>null</code>, no nodes will match (all nodes
- *    gathered via <code>aNodeIterator</code> will be <em>rejected</em> in the resulting filter split).
  * </p>
  * @author Magnus Lövgren
  */
-declare namespace NodeIteratorUtil {
+declare namespace nodeIteratorUtil {
   export {
     getFilteredNodeIterator,
     getNodeIteratorByIdentifier,
@@ -352,4 +246,4 @@ declare namespace NodeIteratorUtil {
   };
 }
 
-export default NodeIteratorUtil;
+export default nodeIteratorUtil;

package/server/NodeIteratorUtil/index.js

@@ -5,16 +5,16 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
-  findAll: function findAll() {},
-  findFirst: function findFirst() {},
-  findNodes: function findNodes() {},
   getFilteredNodeIterator: function getFilteredNodeIterator() {},
+  getNodeIteratorByIdentifier: function getNodeIteratorByIdentifier() {},
   getMenuItems: function getMenuItems() {},
   getMenuItemsByIdentifier: function getMenuItemsByIdentifier() {},
   getMenuItemsIncludingFolders: function getMenuItemsIncludingFolders() {},
   getMenuItemsIncludingFoldersByIdentifier: function getMenuItemsIncludingFoldersByIdentifier() {},
-  getNodeIteratorByIdentifier: function getNodeIteratorByIdentifier() {},
-  split: function split() {},
-  toList: function toList() {}
+  findFirst: function findFirst() {},
+  findNodes: function findNodes() {},
+  findAll: function findAll() {},
+  toList: function toList() {},
+  split: function split() {}
 };
 exports["default"] = _default;