@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/hidden/senselogic/sitevision/api/search/searcher/Searcher/index.d.ts

@@ -0,0 +1,277 @@
+import SearchResult from "../../SearchResult";
+
+/**
+ * <p>
+ *    A searcher with highly configurable behaviour.
+ * </p>
+ *
+ * <p>
+ *    The <code>Searcher</code> is the mother of all querying and the powerful big brother of <code>SearchUtil</code>.
+ *    When the basic convenience methods in {@link senselogic.sitevision.api.search.SearchUtil} doesn't fit your needs,
+ *    you can always use the <code>Searcher</code> instead!
+ * </p>
+ *
+ * <p>
+ *    The behaviour of a <code>Searcher</code> is stipulated via it's assembly of <em>components</em>. The following components are available:
+ * </p>
+ * <ul>
+ *    <li>
+ *       {@link senselogic.sitevision.api.search.searcher.component.Parser}<em>
+ *          - what parser should be used to handle the queries and what field/fields should be queried?
+ *       </em>
+ *    </li>
+ *    <li>
+ *       {@link senselogic.sitevision.api.search.searcher.component.Filter}<em>
+ *          - how should the result be limited?
+ *       </em>
+ *    </li>
+ *    <li>
+ *       {@link senselogic.sitevision.api.search.searcher.component.SpellCheck}<em>
+ *          - should the search engine try to get suggestions (did you mean)?
+ *       </em>
+ *    </li>
+ *    <li>
+ *       {@link senselogic.sitevision.api.search.searcher.component.Highlight}<em>
+ *          - which fields should be highlighted and how?
+ *       </em>
+ *    </li>
+ *    <li>
+ *       {@link senselogic.sitevision.api.search.searcher.component.Sort}<em>
+ *          - how should the result be sorted?
+ *       </em>
+ *    </li>
+ *    <li>
+ *       {@link senselogic.sitevision.api.search.searcher.component.Monitor}<em>
+ *          - how should querying be monitored? (e.g. should search query logging mode be on or off?)
+ *       </em>
+ *    </li>
+ * </ul>
+ * <p>
+ *    All components are optional and are assembled using a {@link senselogic.sitevision.api.search.searcher.builder.SearcherBuilder}.
+ *    When the <code>Searcher</code> is created, it <strong>can be re-used</strong> for subsequent searching.
+ * </p>
+ *
+ * <p>
+ *    <strong>Example of how to get and use a Searcher in Velocity:</strong>
+ * </p>
+ * <pre><code>
+ *   <em>## Get the search factory</em>
+ *   #set ($searchFactory = $sitevisionUtils.searchFactory)
+ *
+ *   <em>## Get the search builder</em>
+ *   #set ($searcherBuilder = $searchFactory.searcherBuilder)
+ *
+ *   <em>## Configure the search builder (use component builders to create whatever components that is needed and add them)</em>
+ *   <em>...</em>
+ *
+ *   <em>## Create the searcher</em>
+ *   #set ($searcher = $searcherBuilder.build())
+ *
+ *   <em>## Search and handle the result</em>
+ *   #set ($searchResult = $searcher.search('example*', 10))
+ *   #if ($searchResult.hasHits())
+ *   &lt;ol&gt;
+ *       #foreach ($hit in $searchResult.hits)
+ *          &lt;li&gt;<em>...</em>&lt;/li&gt;
+ *       #end
+ *   &lt;/ol&gt;
+ *   #end
+ * </code></pre>
+ *
+ * <p>
+ *    What <em>index</em> to query can also be specified via the <code>SearcherBuilder</code>.
+ *    Please note that <em>fields might differ between index</em> so if you query multiple indexes and re-use the <code>SearcherBuilder</code>,
+ *    you must also re-set the components that are field-dependant (e.g. the Sort, the Highlight, the Parser
+ *    if you have specified custom query fields etc.).
+ * </p>
+ * <p>
+ *    <strong>Example of how to query two indexes using server-side JavaScript</strong><br>(i.e. search identities from the the
+ *    <em>user identity index</em> and pages/files/images from the <em>node index</em>):
+ * </p>
+ * <pre><code>
+ *   <em>// Get a search builder</em>
+ *   var searcherBuilder = require('SearcherBuilder');
+ *
+ *   <em>// Build a 'node index' Searcher and search</em>
+ *   var nodeSearcher = searcherBuilder <em>// Will use the default node index</em>
+ *                         .build();
+ *   var nodeResult = nodeSearcher.search('nisse', 3);
+ *
+ *   <em>// Build a 'user identity index' Searcher and search</em>
+ *   var indexUtil = require('IndexUtil');
+ *   var userIdentityIndexType = require('IndexUtil.IndexType.USER_IDENTITY');
+ *   var identityResult = searcherBuilder
+ *                          .setIndex(indexUtil.getDefaultIndex(userIdentityIndexType))
+ *                          .build()
+ *                          .search('nisse', 10);
+ *
+ *   <em>// Iterate results</em>
+ *   var hits, hit;
+ *   if (identityResult.hasHits()) {
+ *      hits = identityResult.getHits();
+ *      while (hits.hasNext()) {
+ *         hit = hits.next();
+ *         <em>// Handle hit from user identity index</em>
+ *         ...
+ *      }
+ *   }
+ *   if (nodeResult.hasHits()) {
+ *      hits = nodeResult.getHits();
+ *      while (hits.hasNext()) {
+ *         hit = hits.next();
+ *         <em>// Handle hit from node index</em>
+ *         ...
+ *      }
+ *   }</code></pre>
+ *
+ * <p>
+ *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
+ *    more information about Builders and how to work with them!
+ * </p>
+ *
+ * <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.search.searcher.builder.SearcherBuilder#build()}.
+ *    See {@link senselogic.sitevision.api.search.searcher.builder.SearcherBuilder} for how to obtain an instance
+ *    of the <code>SearcherBuilder</code> interface.
+ * </p>Executes a search using the components/behaviour that was specified when the <code>Searcher</code> was created.
+ *
+ * <p>
+ *    <em>Note! <code>aQuery</code> will be stripped from Local params,
+ *    see {@link senselogic.sitevision.api.search.query.QueryStringUtil#stripLocalParams(String)}.</em>
+ * </p>Executes a search using the components/behaviour that was specified when the <code>Searcher</code> was created.
+ *
+ * <p>
+ *    This method is typically used if you want to execute a complex query (i.e. <code>aQuery</code>), but display a
+ *    more simpler one (i.e. <code>aDisplayQuery</code>) when rendering the search result.
+ *    Use {@link senselogic.sitevision.api.search.SearchResult#getQuery()} to get the <code>aQuery</code> and use
+ *    {@link senselogic.sitevision.api.search.SearchResult#getDisplayQuery()} to get the <code>aDisplayQuery</code>.
+ * </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>Executes a paginated search using the components/behaviour that was specified when the <code>Searcher</code> was created.
+ *
+ * <p>
+ *    <em>Note! <code>aQuery</code> will be stripped from Local params,
+ *    see {@link senselogic.sitevision.api.search.query.QueryStringUtil#stripLocalParams(String)}.</em>
+ * </p>Executes a paginated search using the components/behaviour that was specified when the <code>Searcher</code> was created.
+ *
+ * <p>
+ *    This method is typically used if you want to execute a paginated complex query (i.e. <code>aQuery</code>), but display a
+ *    more simpler one (i.e. <code>aDisplayQuery</code>) when rendering the search result.
+ *    Use {@link senselogic.sitevision.api.search.SearchResult#getQuery()} to get the <code>aQuery</code> and use
+ *    {@link senselogic.sitevision.api.search.SearchResult#getDisplayQuery()} to get the <code>aDisplayQuery</code>.
+ * </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>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+interface Searcher {
+  /**
+   * Executes a search using the components/behaviour that was specified when the <code>Searcher</code> was created.
+   *
+   * <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 query string
+   * @param aMaxHitsToReturn maximum total number of hits to be returned
+   * @return the search result, never <code>null</code>
+   * @throws IllegalArgumentException if <code>aQuery</code> is null or whitespace-only, if <code>aStartAtHit</code> is negative, if <code>aMaxHitsToReturn</code> is negative or zero.
+   */
+  search(aQuery: string, aMaxHitsToReturn: number): SearchResult;
+
+  /**
+   * Executes a search using the components/behaviour that was specified when the <code>Searcher</code> was created.
+   *
+   * <p>
+   *    This method is typically used if you want to execute a complex query (i.e. <code>aQuery</code>), but display a
+   *    more simpler one (i.e. <code>aDisplayQuery</code>) when rendering the search result.
+   *    Use {@link senselogic.sitevision.api.search.SearchResult#getQuery()} to get the <code>aQuery</code> and use
+   *    {@link senselogic.sitevision.api.search.SearchResult#getDisplayQuery()} to get the <code>aDisplayQuery</code>.
+   * </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 query string
+   * @param aDisplayQuery the "human friendly" variant of the query string that can be used/retrieved when rendering the search result. Note! If <code>aDisplayQuery</code> is <code>null</code>, <code>aQuery</code> will be used as <code>aDisplayQuery</code>.
+   * @param aMaxHitsToReturn maximum total number of hits to be returned
+   * @return the search result, never <code>null</code>
+   * @throws IllegalArgumentException if <code>aQuery</code> is null or whitespace-only, if <code>aStartAtHit</code> is negative, if <code>aMaxHitsToReturn</code> is negative or zero.
+   * @since Sitevision 3.6.4
+   */
+  search(
+    aQuery: string,
+    aDisplayQuery: string,
+    aMaxHitsToReturn: number
+  ): SearchResult;
+
+  /**
+   * Executes a paginated search using the components/behaviour that was specified when the <code>Searcher</code> was created.
+   *
+   * <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 query string
+   * @param aStartAtHit number of leading hits to be skipped
+   * @param aMaxHitsToReturn maximum total number of hits to be returned
+   * @return the search result, never <code>null</code>
+   * @throws IllegalArgumentException if <code>aQuery</code> is null or whitespace-only, if <code>aStartAtHit</code> is negative, if <code>aMaxHitsToReturn</code> is negative or zero.
+   */
+  search(
+    aQuery: string,
+    aStartAtHit: number,
+    aMaxHitsToReturn: number
+  ): SearchResult;
+
+  /**
+   * Executes a paginated search using the components/behaviour that was specified when the <code>Searcher</code> was created.
+   *
+   * <p>
+   *    This method is typically used if you want to execute a paginated complex query (i.e. <code>aQuery</code>), but display a
+   *    more simpler one (i.e. <code>aDisplayQuery</code>) when rendering the search result.
+   *    Use {@link senselogic.sitevision.api.search.SearchResult#getQuery()} to get the <code>aQuery</code> and use
+   *    {@link senselogic.sitevision.api.search.SearchResult#getDisplayQuery()} to get the <code>aDisplayQuery</code>.
+   * </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 query string
+   * @param aDisplayQuery the "human friendly" variant of the query string that can be used/retrieved when rendering the search result. Note! If <code>aDisplayQuery</code> is <code>null</code>, <code>aQuery</code> will be used as <code>aDisplayQuery</code>.
+   * @param aStartAtHit number of leading hits to be skipped
+   * @param aMaxHitsToReturn maximum total number of hits to be returned
+   * @return the search result, never <code>null</code>
+   * @throws IllegalArgumentException if <code>aQuery</code> is null or whitespace-only, if <code>aStartAtHit</code> is negative, if <code>aMaxHitsToReturn</code> is negative or zero.
+   * @since Sitevision 3.6.4
+   */
+  search(
+    aQuery: string,
+    aDisplayQuery: string,
+    aStartAtHit: number,
+    aMaxHitsToReturn: number
+  ): SearchResult;
+}
+
+export default Searcher;

package/hidden/senselogic/sitevision/api/search/searcher/component/Filter/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * <p>
+ *    A filter component that defines the filtering behaviour for a {@link senselogic.sitevision.api.search.searcher.Searcher}.
+ * </p>
+ *
+ * <p>
+ *    The actual behaviour is specified when it is constructed using the
+ *    {@link senselogic.sitevision.api.search.searcher.builder.FilterBuilder}.
+ *    The component is applied to the <code>Searcher</code> via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.SearcherBuilder#setFilter(Filter)}
+ *    when the <code>Searcher</code> is constructed.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.FilterBuilder#build()}.
+ *    See {@link senselogic.sitevision.api.search.searcher.builder.FilterBuilder} for how to obtain an instance of the
+ *    <code>FilterBuilder</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+interface Filter {}
+
+export default Filter;

package/hidden/senselogic/sitevision/api/search/searcher/component/Highlight/index.d.ts

@@ -0,0 +1,29 @@
+/**
+ * <p>
+ *    A highlight component that defines the highlighting behaviour for a {@link senselogic.sitevision.api.search.searcher.Searcher}.
+ * </p>
+ *
+ * <p>
+ *    The actual behaviour is specified when it is constructed using the
+ *    {@link senselogic.sitevision.api.search.searcher.builder.HighlightBuilder}
+ *    The component is applied to the <code>Searcher</code> via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.SearcherBuilder#setHighlight(Highlight)}
+ *    when the <code>Searcher</code> is constructed.
+ * </p>
+ *
+ * <p>
+ *    <em>Solr note: this component depicts the solr.HighlightComponent</em>
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.HighlightBuilder#build()}.
+ *    See {@link senselogic.sitevision.api.search.searcher.builder.HighlightBuilder} for how to obtain an instance of the
+ *    <code>HighlightBuilder</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+interface Highlight {}
+
+export default Highlight;

package/hidden/senselogic/sitevision/api/search/searcher/component/Monitor/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * <p>
+ *    A monitor component that defines monitoring behaviour for a {@link senselogic.sitevision.api.search.searcher.Searcher}.
+ * </p>
+ *
+ * <p>
+ *    The actual behaviour is specified when it is constructed using the
+ *    {@link senselogic.sitevision.api.search.searcher.builder.MonitorBuilder}
+ *    The component is applied to the <code>Searcher</code> via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.SearcherBuilder#setMonitor(Monitor)}
+ *    when the <code>Searcher</code> is constructed.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.MonitorBuilder#build()}.
+ *    See {@link senselogic.sitevision.api.search.searcher.builder.MonitorBuilder} for how to obtain an instance of the
+ *    <code>MonitorBuilder</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 4.1
+ */
+interface Monitor {}
+
+export default Monitor;

package/hidden/senselogic/sitevision/api/search/searcher/component/Parser/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * <p>
+ *    A parser component that defines the query parsing behaviour for a {@link senselogic.sitevision.api.search.searcher.Searcher}.
+ * </p>
+ *
+ * <p>
+ *    The component behaviour is specified when it is constructed and it is applied to the <code>Searcher</code> via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.SearcherBuilder#setParser(Parser)}
+ *    when the <code>Searcher</code> is constructed. There are two parsers available:
+ * </p>
+ * <ul>
+ *    <li>
+ *       A <em>multi-field</em> parser is configured via the {@link senselogic.sitevision.api.search.searcher.builder.ExtendedDismaxParserBuilder}
+ *    </li>
+ *    <li>
+ *       A <em>single-field</em> parser is configured via the {@link senselogic.sitevision.api.search.searcher.builder.StandardParserBuilder}
+ *    </li>
+ * </ul>
+ * <p>
+ *    The default Sitevision portlets use the <em>ExtendedDismaxParser</em>.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.ExtendedDismaxParserBuilder#build()}
+ *    or {@link senselogic.sitevision.api.search.searcher.builder.StandardParserBuilder#build()}.
+ *    See {@link senselogic.sitevision.api.search.searcher.builder.ExtendedDismaxParserBuilder} or
+ *    {@link senselogic.sitevision.api.search.searcher.builder.StandardParserBuilder} for how to obtain such instance.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+interface Parser {}
+
+export default Parser;

package/hidden/senselogic/sitevision/api/search/searcher/component/Sort/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * <p>
+ *    A sort component that defines the sorting behaviour for a {@link senselogic.sitevision.api.search.searcher.Searcher}.
+ * </p>
+ *
+ * <p>
+ *    The actual behaviour is specified when it is constructed using the
+ *    {@link senselogic.sitevision.api.search.searcher.builder.SortBuilder}
+ *    The component is applied to the <code>Searcher</code> via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.SearcherBuilder#setSort(Sort)}
+ *    when the <code>Searcher</code> is constructed.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.SortBuilder#build()}.
+ *    See {@link senselogic.sitevision.api.search.searcher.builder.SortBuilder} for how to obtain an instance of the
+ *    <code>SortBuilder</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+interface Sort {}
+
+export default Sort;

package/hidden/senselogic/sitevision/api/search/searcher/component/SpellCheck/index.d.ts

@@ -0,0 +1,29 @@
+/**
+ * <p>
+ *    A spell check component that defines the "did you mean" behaviour for a {@link senselogic.sitevision.api.search.searcher.Searcher}.
+ * </p>
+ *
+ * <p>
+ *    The actual behaviour is specified when it is constructed using the
+ *    {@link senselogic.sitevision.api.search.searcher.builder.SpellCheckBuilder}
+ *    The component is applied to the <code>Searcher</code> via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.SearcherBuilder#setSpellCheck(SpellCheck)}
+ *    when the <code>Searcher</code> is constructed.
+ * </p>
+ *
+ * <p>
+ *    <em>Solr note: this component depicts the solr.SpellCheckComponent</em>
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.searcher.builder.SpellCheckBuilder#build()}.
+ *    See {@link senselogic.sitevision.api.search.searcher.builder.SpellCheckBuilder} for how to obtain an instance of the
+ *    <code>SpellCheckBuilder</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+interface SpellCheck {}
+
+export default SpellCheck;

package/hidden/senselogic/sitevision/api/search/sort/CustomSort/index.d.ts

@@ -0,0 +1,82 @@
+/**
+ * A custom sort that enables users to re-sort the search result
+ * on a certain index field with a certain sort order.Gets the name of this custom sort.Gets the identifier of this custom sort.Gets the name of the index field this custom sort uses.Whether the sort order is descending or not.Whether or not this custom sort is selected.Gets the relative URL for this custom sort.Returns the query parameters for this custom sort.
+ *
+ * <p>
+ *    The sort query params is a sub-set of the sort URL.
+ * </p>
+ *
+ * <p>
+ *    An example: If the sortURL is:<br>
+ *    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>/a/b/c.html?query=d&amp;e=f&amp;g=h</code><br>
+ *    the sortQueryParams will be:<br>
+ *    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>d&amp;e=f&amp;g=h</code><br>
+ *    <em>
+ *       (Note that the value starts with the "query" parameter, but <strong>without</strong> the actual query parameter
+ *       name: '<span style="text-decoration:line-through">query=</span>')
+ *    </em>
+ * </p>
+ * @author Magnus Lövgren
+ * @see senselogic.sitevision.api.search.SearchResult#getCustomSorts()
+ * @since Sitevision 3.1
+ */
+interface CustomSort {
+  /**
+   * Gets the name of this custom sort.
+   * @return the sort name
+   */
+  getName(): string;
+
+  /**
+   * Gets the identifier of this custom sort.
+   * @return the sort identifier
+   */
+  getSortId(): string;
+
+  /**
+   * Gets the name of the index field this custom sort uses.
+   * @return the field name
+   */
+  getField(): string;
+
+  /**
+   * Whether the sort order is descending or not.
+   * @return <code>true</code> if the order of this custom this sort is <em>descending</em>, <code>false</code> otherwise (i.e. order is <em>ascending</em>)
+   */
+  isDescending(): boolean;
+
+  /**
+   * Whether or not this custom sort is selected.
+   * @return <code>true</code> if this sort is selected, <code>false</code> otherwise
+   */
+  isSelected(): boolean;
+
+  /**
+   * Gets the relative URL for this custom sort.
+   * @return the URL for this custom sort
+   */
+  getSortURL(): string;
+
+  /**
+   * Returns the query parameters for this custom sort.
+   *
+   * <p>
+   *    The sort query params is a sub-set of the sort URL.
+   * </p>
+   *
+   * <p>
+   *    An example: If the sortURL is:<br>
+   *    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>/a/b/c.html?query=d&amp;e=f&amp;g=h</code><br>
+   *    the sortQueryParams will be:<br>
+   *    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>d&amp;e=f&amp;g=h</code><br>
+   *    <em>
+   *       (Note that the value starts with the "query" parameter, but <strong>without</strong> the actual query parameter
+   *       name: '<span style="text-decoration:line-through">query=</span>')
+   *    </em>
+   * </p>
+   * @return the query parameters, with the actual query parameter first with no name
+   */
+  getSortQueryParams(): string;
+}
+
+export default CustomSort;

package/hidden/senselogic/sitevision/api/search/suggestion/SearchSuggestion/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A "Did you mean" suggestion for a search result.Number of expected hits for this suggestionThe name/expression of the suggestion
+ * @author Magnus Lövgren
+ * @since Sitevision 3.0
+ * @see senselogic.sitevision.api.search.SearchResult#getSuggestions()
+ */
+interface SearchSuggestion {
+  /**
+   * Number of expected hits for this suggestion
+   * @return number of expected hits, or <code>-1</code> if unavailable
+   */
+  getCount(): number;
+
+  /**
+   * The name/expression of the suggestion
+   * @return the suggestion name
+   */
+  getName(): string;
+}
+
+export default SearchSuggestion;

package/hidden/senselogic/sitevision/api/security/DirectoryAttributes/index.d.ts

@@ -0,0 +1,70 @@
+/**
+ * <p>
+ *    Interface exposing directory attributes of an internal directory object. The attribute name is the LDAP / Directory attribute
+ *    name which is not the same thing as the internal field name represented by Field.Id. The mapping between
+ *    field name and attribute name is defined in the attribute mapping in LdapSchema.
+ * </p>
+ *
+ * <p>
+ *    This API can also be used to get / set attributes "outside" of the schema.
+ *    Set methods operates directly to the LDAP source!
+ *    The methods will never throw exceptions. Any problem will be written to the server log.
+ * </p>
+ *
+ * <p>
+ *    <em>Note!</em> an initial lookup in the UserObjectProperties will be made to see if the attribute is available.
+ *    If a lookup to a Directory/LDAP source is required, the resulting value will be stored in the UserObjectProperties
+ *    to avoid further calls.
+ * </p>
+ *
+ * <p>
+ *    <strong>Deprecation note!</strong> This is a deprecated legacy interface for operating on "internal" Sitevision objects.
+ *    Use {@link senselogic.sitevision.api.security.DirectoryUtil} to get LDAP values for a directory object <code>Node</code>.
+ * </p>Returns the directory attribute values for the given attribute name.Sets directory attributes on a directory object. <br>
+ * This method silently discards any exception that might occur.Returns the directory attribute value for the given attribute name.Sets directory attributes on a directory object. <br>
+ * This method silently discards any exception that might occur.Returns the directory attribute value as a <code>String</code> if <code>returnAsString</code>
+ * equals <code>true</code>.
+ * @author Karl Eklöf
+ */
+interface DirectoryAttributes {
+  /**
+   * Returns the directory attribute values for the given attribute name.
+   * @param anAttributeName The attribute name for which to get the attribute value for.
+   * @return The attribute value which maps to the given attribute name or <code>null</code> if no value maps to the given name.
+   */
+  getAttributeValues(anAttributeName: string): unknown[];
+
+  /**
+   * Sets directory attributes on a directory object. <br>
+   * This method silently discards any exception that might occur.
+   * @param anAttributeName The directory attribute to set.
+   * @param aValues The directory values to be set.
+   */
+  setAttributeValues(anAttributeName: string, aValues: unknown[]): void;
+
+  /**
+   * Returns the directory attribute value for the given attribute name.
+   * @param anAttributeName The attribute name for which to get the attribute value for.
+   * @return The attribute value which maps to the given attribute name or <code>null</code> if no value maps to the given name.
+   */
+  getAttributeValue(anAttributeName: string): unknown;
+
+  /**
+   * Sets directory attributes on a directory object. <br>
+   * This method silently discards any exception that might occur.
+   * @param anAttributeName The directory attribute to set.
+   * @param aValue The directory value to be set.
+   */
+  setAttributeValue(anAttributeName: string, aValue: string): void;
+
+  /**
+   * Returns the directory attribute value as a <code>String</code> if <code>returnAsString</code>
+   * equals <code>true</code>.
+   * @param anAttributeName The attribute name for which to get the attribute value for.
+   * @param returnAsString If <code>true</code> the value is returned as a <code>String</code>.
+   * @return The attribute value as a <code>String</code> if <code>returnAsString</code> equals <code>true</code> or <code>null</code> if no value maps to the given name.
+   */
+  getAttributeValue(anAttributeName: string, returnAsString: boolean): unknown;
+}
+
+export default DirectoryAttributes;