@sitevision/api 2.0.0-alpha.0 → 2.0.0-alpha.1

package/hidden/senselogic/sitevision/api/search/SearchFactory/index.d.ts

@@ -1,114 +0,0 @@
-import ExtendedDismaxParserBuilder from "../searcher/builder/ExtendedDismaxParserBuilder";
-import FilterBuilder from "../searcher/builder/FilterBuilder";
-import HighlightBuilder from "../searcher/builder/HighlightBuilder";
-import IndexUtil from "../index/IndexUtil";
-import IndexingUtil from "../index/IndexingUtil";
-import SearcherBuilder from "../searcher/builder/SearcherBuilder";
-import SortBuilder from "../searcher/builder/SortBuilder";
-
-import SearchUtil from "../SearchUtil";
-import SpellCheckBuilder from "../searcher/builder/SpellCheckBuilder";
-import StandardParserBuilder from "../searcher/builder/StandardParserBuilder";
-import QueryStringUtil from "../query/QueryStringUtil";
-import MonitorBuilder from "../searcher/builder/MonitorBuilder";
-
-/**
- * Factory for creating search-related instances.
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getSearchFactory()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.6
- */
-
-interface SearchFactory {
-  /**
-   * Gets a ExtendedDismaxParserBuilder instance.
-   * @return a ExtendedDismaxParserBuilder instance
-   */
-  getExtendedDismaxParserBuilder(): ExtendedDismaxParserBuilder;
-
-  /**
-   * Gets a FilterBuilder instance.
-   * @return a FilterBuilder instance
-   */
-  getFilterBuilder(): FilterBuilder;
-
-  /**
-   * Gets a HighlightBuilder instance.
-   * @return a HighlightBuilder instance
-   */
-  getHighlightBuilder(): HighlightBuilder;
-
-  /**
-   * Gets an IndexUtil instance.
-   * @return an IndexUtil instance
-   */
-  getIndexUtil(): IndexUtil;
-
-  /**
-   * Gets an IndexingUtil instance.
-   * @return an IndexingUtil instance
-   * @since Sitevision 3.6.4
-   */
-  getIndexingUtil(): IndexingUtil;
-
-  /**
-   * Gets a SearcherBuilder instance.
-   * @return a SearcherBuilder instance
-   */
-  getSearcherBuilder(): SearcherBuilder;
-
-  /**
-   * Gets a SortBuilder instance.
-   * @return a SortBuilder instance
-   */
-  getSortBuilder(): SortBuilder;
-
-  /**
-   * Convenience method to get a SearchSortField instance.
-   * @param aField name of the sortable index field
-   * @param aIsAscending the sort order (true == ascending, false == descending)
-   * @return a SearchSortField instance
-   * @throws IllegalArgumentException if aField is null or whitespace-only
-   */
-  getSearchSortField(
-    aField: java.lang.String,
-    aIsAscending: boolean
-  ): SearchSortField;
-
-  /**
-   * Convenience method to get a SearchUtil instance.
-   *
-   * <em>A SearchUtil instance can also be retrieved via the {@link senselogic.sitevision.api.Utils#getSearchUtil()}</em>
-   * @return a SearchUtil instance
-   */
-  getSearchUtil(): SearchUtil;
-
-  /**
-   * Gets a SpellCheckBuilder instance.
-   * @return a SpellCheckBuilder instance
-   */
-  getSpellCheckBuilder(): SpellCheckBuilder;
-
-  /**
-   * Gets a StandardParserBuilder instance.
-   * @return a StandardParserBuilder instance
-   */
-  getStandardParserBuilder(): StandardParserBuilder;
-
-  /**
-   * Gets a QueryStringUtil instance.
-   * @return a QueryStringUtil instance
-   */
-  getQueryStringUtil(): QueryStringUtil;
-
-  /**
-   * Gets a MonitorBuilder instance.
-   * @return a MonitorBuilder instance
-   * @since Sitevision 4.1
-   */
-  getMonitorBuilder(): MonitorBuilder;
-}

package/hidden/senselogic/sitevision/api/search/SearchUtil/index.d.ts

@@ -1,126 +0,0 @@
-import SearchResult from "../SearchResult";
-
-/**
- * <p>
- *    Convenience interface for querying the default index.
- * </p>
- *
- * <div style="border:1px dotted gray; padding-left:10px; padding-right:10px; padding-bottom:10px">
- *    <p>
- *       <strong>Note!</strong> This interface contains convenience methods for basic search in the default index.
- *       When more powerful search behaviour is needed - use {@link senselogic.sitevision.api.search.searcher.Searcher} instead!
- *       <em>Actually, you can always use Searcher, but not always SearchUtil</em>.
- *    </p>
- *    <p>
- *       Examples of when you <em>must</em> use {@link senselogic.sitevision.api.search.searcher.Searcher} instead is:
- *    </p>
- *    <ul>
- *       <li>
- *          You want to query <em>another index</em> (not the default index).
- *       </li>
- *       <li>
- *          You want to do multi-field querying and want to <em>specify query fields</em> (not use the default ones specified by the index).
- *       </li>
- *       <li>
- *          You want to use a <em>filter</em> to separate the "user" query and the "filter" query (which also improves performance).
- *       </li>
- *       <li>
- *          You want to <em>highlight</em> one or more fields in the search result.
- *       </li>
- *       <li>
- *          You want <em>suggestions ("did you mean")</em> in the search result.
- *       </li>
- *    </ul>
- * </div>
- *
- * <p>
- *    <strong>Query syntax note! </strong>Query strings should be expressed according to the <em>Solr query syntax</em>.
- *    The syntax is basically the
- *    <em><a href="http://lucene.apache.org/core/4_10_3/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">
- *       Lucene query syntax</a></em>
- *    with <em><a href="http://wiki.apache.org/solr/SolrQuerySyntax#Differences_From_Lucene_Query_Parser">some minor differences</a></em>.
- *    Also note that a general recommendation is to always use the <em>prefix operators</em> (<code>+</code>/<code>-</code>) instead of the
- *    <em>boolean keywords</em> (AND/OR/NOT)
- *    to avoid unexpected behaviour. For deeper understanding, see for example
- *    <a href="https://lucidworks.com/blog/2011/12/28/why-not-and-or-and-not/">Why Not AND, OR, And NOT?</a>.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getSearchUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- * @author Mikael Wikblom
- * @since Sitevision 2.6_06
- * @see senselogic.sitevision.api.search.searcher.Searcher
- */
-
-interface SearchUtil {
-  /**
-   * <p>
-   *    Searches the default index using the <em>multi-field</em> ("edismax") parser.
-   * </p>
-   *
-   * <p>
-   *    Here is a simple example written in server-side javascript:
-   * </p>
-   * <pre><code>
-   * var searchUtil = request.getAttribute("sitevision.utils").getSearchUtil();
-   * var result = searchUtil.search("test*", null, 0, 10);
-   * if (result.hasHits()) {
-   *    out.println("Approximate hit count: " + result.getApproximateCount() + "&lt;br/&gt;");
-   *    var hits = result.getHits();
-   *    while (hits.hasNext()) {
-   *       var hit = hits.next();
-   *       out.print("&lt;a href=\"" + hit.getField('uri') + "\" title=\"\"&gt;");
-   *       out.print(hit.getField('title'));
-   *       out.print("&lt;/a&gt;");
-   *       out.println("&lt;br/&gt;");
-   *    }
-   * } else {
-   *    out.println("No hits for query = '" + result.getQuery() + "'&lt;br/&gt;");
-   * }
-   * </code></pre>
-   *
-   * <p>
-   *    <em>Note! <code>aQuery</code> will be stripped from Local params,
-   *    see {@link senselogic.sitevision.api.search.query.QueryStringUtil#stripLocalParams(String)}.</em>
-   * </p>
-   * @param aQuery The search query according to the <em>Solr query syntax</em>
-   * @param sortFields A <code>List</code> of {@link SearchSortField} objects. May be <code>null</code>.
-   * @param aStartAtHit number of leading hits to be skipped
-   * @param aMaxHitsToReturn maximum total number of hits to be returned
-   * @return The search returns a {@link SearchResult} and is never <code>null</code>
-   */
-  search(
-    aQuery: java.lang.String,
-    sortFields: java.util.List,
-    aStartAtHit: int,
-    aMaxHitsToReturn: int
-  ): SearchResult;
-
-  /**
-   * <p>
-   *    Searches the default index using the <em>single-field</em> ("standard") parser with a specified default field.
-   * </p>
-   *
-   * <p>
-   *    <em>Note! <code>aQuery</code> will be stripped from Local params,
-   *    see {@link senselogic.sitevision.api.search.query.QueryStringUtil#stripLocalParams(String)}.</em>
-   * </p>
-   * @param aQuery The search query according to the <em>Solr query syntax</em>
-   * @param aFieldName name of the field that should be queried
-   * @param sortFields A <code>List</code> of {@link SearchSortField} objects. May be <code>null</code>.
-   * @param aStartAtHit number of leading hits to be skipped
-   * @param aMaxHitsToReturn maximum total number of hits to be returned
-   * @return a {@link SearchResult} and is never <code>null</code>
-   * @since Sitevision 2.7_06
-   * @since Sitevision 3.0
-   */
-  search(
-    aQuery: java.lang.String,
-    aFieldName: java.lang.String,
-    sortFields: java.util.List,
-    aStartAtHit: int,
-    aMaxHitsToReturn: int
-  ): SearchResult;
-}

package/hidden/senselogic/sitevision/api/search/index/IndexUtil/index.d.ts

@@ -1,50 +0,0 @@
-import Node from "../../../../../../javax/jcr/Node";
-
-/**
- * Index utility interface.
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.search.SearchFactory#getIndexUtil()}.
- *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.6
- */
-
-interface IndexUtil {
-  /**
-   * Gets the default index for a specified index type.
-   *
-   * <p>
-   *    <strong>Note!</strong>The default user identity index is only handled if a <em>Social Collaboration</em> license is in use.
-   *    The default user-generated content (UGC) index is only handled if a <em>Social Collaboration</em> license is in use.
-   * </p>
-   * @param aIndexType type of index
-   * @return the default index for <code>aIndexType</code>, or <code>null</code> if not available
-   */
-  getDefaultIndex(
-    aIndexType: senselogic.sitevision.api.search.index.IndexUtil.IndexType
-  ): Node;
-
-  /**
-   * Gets an index by name.
-   *
-   * <p>
-   *    Lookup order:
-   * </p>
-   * <ol>
-   *    <li>Custom <em>site</em> index</li>
-   *    <li>Custom <em>server</em> index</li>
-   *    <li><em>Default</em> index(-es), types specified by {@link senselogic.sitevision.api.search.index.IndexUtil.IndexType}</li>
-   * </ol>
-   * <p>
-   *    <strong>Note!</strong> Custom index is only handled if a <em>Search Package 2</em> license is in use.
-   *    The default user identity index is only handled if a <em>Social Collaboration</em> license is in use.
-   *    The default user-generated content (UGC) index is only handled if a <em>Social Collaboration</em> license is in use.
-   * </p>
-   * @param aIndexName the name of the index
-   * @return the index or <code>null</code> if no index matches <code>aIndexName</code>
-   */
-  getIndexByName(aIndexName: java.lang.String): Node;
-}

package/hidden/senselogic/sitevision/api/search/index/IndexingUtil/index.d.ts

@@ -1,59 +0,0 @@
-import Node from "../../../../../../javax/jcr/Node";
-
-/**
- * Indexing utility interface.
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.search.SearchFactory#getIndexingUtil()}.
- *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
- * </p>The minimum resource priority.
- *
- * A resource indexed with this priority value will get a document boost of <code>0.1F</code>.The default resource priority.
- *
- * A resource indexed with this priority value will get the default document boost of <code>1.0F</code>.The maximum resource priority.
- *
- * A resource indexed with this priority value will get a document boost of <code>2.0F</code>.
- * @author Magnus Lövgren
- * @since Sitevision 3.6.4
- */
-
-interface IndexingUtil {
-  /**
-   * Sets the resource priority for an indexable node.
-   *
-   * <p>
-   *    The <em>resource priority</em> of a node will influence its <em>document boost</em> when indexed.
-   * </p>
-   *
-   * <p>
-   *    <strong>Note!</strong> Method invocations that doesn't fulfill these 3 criteria will always fail (i.e. return <code>false</code>):
-   * </p>
-   * <ul>
-   *    <li>
-   *       The <code>aNode</code> must be an indexable node, typically a <code>sv:page</code>, <code>sv:article</code>,
-   *       <code>sv:file</code> or <code>sv:image</code>.
-   *    </li>
-   *    <li>
-   *       The <code>aPriority</code> must be in interval: [ {@link #MIN_RESOURCE_PRIORITY} .. {@link #MAX_RESOURCE_PRIORITY} ].
-   *    </li>
-   *    <li>
-   *       Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} and
-   *       {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MODIFY_SEARCH_PRIORITY}
-   *       on <code>aNode</code>.
-   *    </li>
-   * </ul>
-   * <p>
-   *    This method tries to acquire a <em>lock</em> on <code>aNode</code> in order to mutate its resource priority.
-   *    Mutation will fail (i.e. this method will return <code>false</code>) if <code>aNode</code> is already locked.
-   * </p>
-   *
-   * <p>
-   *    <em>Indexing note!</em> Changing the value of the resource priority of a node will automatically trigger a re-index of the node.
-   * </p>
-   * @param aNode the indexable node
-   * @param aPriority the priority, i.e. in interval: [ {@link #MIN_RESOURCE_PRIORITY} .. {@link #MAX_RESOURCE_PRIORITY} ]
-   * @return <code>true</code> if the operation succeeded, <code>false</code> otherwise
-   */
-  setResourcePriority(aNode: Node, aPriority: int): boolean;
-}