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

package/server/SearchFactory/index.d.ts

@@ -1,104 +1,16 @@
-import ExtendedDismaxParserBuilder from "../ExtendedDismaxParserBuilder";
-import FilterBuilder from "../FilterBuilder";
-import HighlightBuilder from "../HighlightBuilder";
-import IndexUtil from "../IndexUtil";
-import IndexingUtil from "../IndexingUtil";
-import SearcherBuilder from "../SearcherBuilder";
-import SortBuilder from "../SortBuilder";
-
-import SearchUtil from "../SearchUtil";
-import SpellCheckBuilder from "../SpellCheckBuilder";
-import StandardParserBuilder from "../StandardParserBuilder";
-import QueryStringUtil from "../QueryStringUtil";
-import MonitorBuilder from "../MonitorBuilder";
-
-/**
- * Gets a ExtendedDismaxParserBuilder instance.
- * @return a ExtendedDismaxParserBuilder instance
- */
-export function getExtendedDismaxParserBuilder(): ExtendedDismaxParserBuilder;
-
-/**
- * Gets a FilterBuilder instance.
- * @return a FilterBuilder instance
- */
-export function getFilterBuilder(): FilterBuilder;
-
-/**
- * Gets a HighlightBuilder instance.
- * @return a HighlightBuilder instance
- */
-export function getHighlightBuilder(): HighlightBuilder;
-
-/**
- * Gets an IndexUtil instance.
- * @return an IndexUtil instance
- */
-export function getIndexUtil(): IndexUtil;
-
-/**
- * Gets an IndexingUtil instance.
- * @return an IndexingUtil instance
- * @since Sitevision 3.6.4
- */
-export function getIndexingUtil(): IndexingUtil;
-
-/**
- * Gets a SearcherBuilder instance.
- * @return a SearcherBuilder instance
- */
-export function getSearcherBuilder(): SearcherBuilder;
-
-/**
- * Gets a SortBuilder instance.
- * @return a SortBuilder instance
- */
-export function 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
- */
-export function getSearchSortField(
-  aField: string,
-  aIsAscending: boolean
-): unknown;
-
-/**
- * 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
- */
-export function getSearchUtil(): SearchUtil;
-
-/**
- * Gets a SpellCheckBuilder instance.
- * @return a SpellCheckBuilder instance
- */
-export function getSpellCheckBuilder(): SpellCheckBuilder;
-
-/**
- * Gets a StandardParserBuilder instance.
- * @return a StandardParserBuilder instance
- */
-export function getStandardParserBuilder(): StandardParserBuilder;
-
-/**
- * Gets a QueryStringUtil instance.
- * @return a QueryStringUtil instance
- */
-export function getQueryStringUtil(): QueryStringUtil;
-
-/**
- * Gets a MonitorBuilder instance.
- * @return a MonitorBuilder instance
- * @since Sitevision 4.1
- */
-export function getMonitorBuilder(): MonitorBuilder;
+import type { ExtendedDismaxParserBuilder } from "../ExtendedDismaxParserBuilder";
+import type { FilterBuilder } from "../FilterBuilder";
+import type { HighlightBuilder } from "../HighlightBuilder";
+import type { IndexUtil } from "../IndexUtil";
+import type { IndexingUtil } from "../IndexingUtil";
+import type { SearcherBuilder } from "../SearcherBuilder";
+import type { SortBuilder } from "../SortBuilder";
+
+import type { SearchUtil } from "../SearchUtil";
+import type { SpellCheckBuilder } from "../SpellCheckBuilder";
+import type { StandardParserBuilder } from "../StandardParserBuilder";
+import type { QueryStringUtil } from "../QueryStringUtil";
+import type { MonitorBuilder } from "../MonitorBuilder";
 
 /**
  * Factory for creating search-related instances.
@@ -110,22 +22,95 @@ export function getMonitorBuilder(): MonitorBuilder;
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace searchFactory {
-  export {
-    getExtendedDismaxParserBuilder,
-    getFilterBuilder,
-    getHighlightBuilder,
-    getIndexUtil,
-    getIndexingUtil,
-    getSearcherBuilder,
-    getSortBuilder,
-    getSearchSortField,
-    getSearchUtil,
-    getSpellCheckBuilder,
-    getStandardParserBuilder,
-    getQueryStringUtil,
-    getMonitorBuilder,
-  };
+export 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: string, aIsAscending: boolean): unknown;
+
+  /**
+   * 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;
 }
 
+declare namespace SearchFactory {}
+
+declare var searchFactory: SearchFactory;
+
 export default searchFactory;

package/server/SearchUtil/index.d.ts

@@ -1,74 +1,5 @@
 import type { SearchResult } from "../../types/senselogic/sitevision/api/search/SearchResult";
 
-/**
- * <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>
- */
-export function search(
-  aQuery: string,
-  sortFields: unknown,
-  aStartAtHit: number,
-  aMaxHitsToReturn: number
-): 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
- */
-export function search(
-  aQuery: string,
-  aFieldName: string,
-  sortFields: unknown,
-  aStartAtHit: number,
-  aMaxHitsToReturn: number
-): SearchResult;
-
 /**
  * <p>
  *    Convenience interface for querying the default index.
@@ -122,8 +53,79 @@ export function search(
  * @since Sitevision 2.6_06
  * @see senselogic.sitevision.api.search.searcher.Searcher
  */
-declare namespace searchUtil {
-  export { search };
+export 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: string,
+    sortFields: unknown,
+    aStartAtHit: number,
+    aMaxHitsToReturn: number
+  ): 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: string,
+    aFieldName: string,
+    sortFields: unknown,
+    aStartAtHit: number,
+    aMaxHitsToReturn: number
+  ): SearchResult;
 }
 
+declare namespace SearchUtil {}
+
+declare var searchUtil: SearchUtil;
+
 export default searchUtil;

package/server/SearcherBuilder/index.d.ts

@@ -8,109 +8,6 @@ import type { Monitor } from "../../types/senselogic/sitevision/api/search/searc
 import type { Searcher } from "../../types/senselogic/sitevision/api/search/searcher/Searcher";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
-/**
- * Sets the filter component.
- *
- * <p>
- *    A <code>Filter</code> instance is created via the {@link FilterBuilder#build()} method.
- * </p>
- * @param aFilter the filter component
- * @return this builder
- * @see FilterBuilder
- */
-export function setFilter(aFilter: Filter): SearcherBuilder;
-
-/**
- * Sets the highlight component.
- *
- * <p>
- *    A <code>Highlight</code> instance is created via the {@link HighlightBuilder#build()} method.
- * </p>
- * @param aHighlight the highlight component
- * @return this builder
- * @see HighlightBuilder
- */
-export function setHighlight(aHighlight: Highlight): SearcherBuilder;
-
-/**
- * Sets the index to search in.
- *
- * <p>
- *    <strong>Note!</strong> If no index is set, the <code>Searcher</code> that is constructed will use
- *    the <em>default node index</em> (i.e. the main index with pages/images/files etc.).
- * </p>
- *
- * <p>
- *    <strong>Tip!</strong> Use the {@link senselogic.sitevision.api.search.index.IndexUtil} utility to get an index.
- * </p>
- * @param anIndex the index
- * @return this builder
- * @throws IllegalArgumentException if <code>anIndex</code> isn't an index node (primary node type name should be <code>sv:nodeIndex</code> or <code>sv:applicationIndex</code>)
- */
-export function setIndex(anIndex: Node): SearcherBuilder;
-
-/**
- * Sets the parser component.
- *
- * <p>
- *    A <code>Parser</code> instance is created via the {@link ExtendedDismaxParserBuilder#build()} method
- *    or the {@link StandardParserBuilder#build()} method.
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> If no Parser is set, the <code>Searcher</code> that is constructed will use a <em>default multi-field
- *    parser</em> (that can be constructed via {@link ExtendedDismaxParserBuilder}).
- * </p>
- * @param aParser the parser component
- * @return this builder
- * @see ExtendedDismaxParserBuilder
- * @see StandardParserBuilder
- */
-export function setParser(aParser: Parser): SearcherBuilder;
-
-/**
- * Sets the sort component.
- *
- * <p>
- *    A <code>Sort</code> instance is created via the {@link SortBuilder#build()} method.
- * </p>
- * @param aSort the sort component
- * @return this builder
- * @see SortBuilder
- */
-export function setSort(aSort: Sort): SearcherBuilder;
-
-/**
- * Sets the spell check (suggestions/did-you-mean) component.
- *
- * <p>
- *    A <code>SpellCheck</code> instance is created via the {@link SpellCheckBuilder#build()} method.
- * </p>
- * @param aSpellCheck the spell check component
- * @return this builder
- * @see SpellCheckBuilder
- */
-export function setSpellCheck(aSpellCheck: SpellCheck): SearcherBuilder;
-
-/**
- * Sets the monitor component.
- *
- * <p>
- *    A <code>Monitor</code> instance is created via the {@link MonitorBuilder#build()} method.
- * </p>
- * @param aMonitor the monitor component
- * @return this builder
- * @see MonitorBuilder
- * @since Sitevision 4.1
- */
-export function setMonitor(aMonitor: Monitor): SearcherBuilder;
-
-/**
- * Creates a Searcher instance using currently specified components.
- * @return a Searcher instance
- */
-export function build(): Searcher;
-
 /**
  * <p>
  *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.Searcher} with a specific setup of components.
@@ -206,17 +103,113 @@ export function build(): Searcher;
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace searcherBuilder {
-  export {
-    setFilter,
-    setHighlight,
-    setIndex,
-    setParser,
-    setSort,
-    setSpellCheck,
-    setMonitor,
-    build,
-  };
+export interface SearcherBuilder extends Builder {
+  /**
+   * Sets the filter component.
+   *
+   * <p>
+   *    A <code>Filter</code> instance is created via the {@link FilterBuilder#build()} method.
+   * </p>
+   * @param aFilter the filter component
+   * @return this builder
+   * @see FilterBuilder
+   */
+  setFilter(aFilter: Filter): SearcherBuilder;
+
+  /**
+   * Sets the highlight component.
+   *
+   * <p>
+   *    A <code>Highlight</code> instance is created via the {@link HighlightBuilder#build()} method.
+   * </p>
+   * @param aHighlight the highlight component
+   * @return this builder
+   * @see HighlightBuilder
+   */
+  setHighlight(aHighlight: Highlight): SearcherBuilder;
+
+  /**
+   * Sets the index to search in.
+   *
+   * <p>
+   *    <strong>Note!</strong> If no index is set, the <code>Searcher</code> that is constructed will use
+   *    the <em>default node index</em> (i.e. the main index with pages/images/files etc.).
+   * </p>
+   *
+   * <p>
+   *    <strong>Tip!</strong> Use the {@link senselogic.sitevision.api.search.index.IndexUtil} utility to get an index.
+   * </p>
+   * @param anIndex the index
+   * @return this builder
+   * @throws IllegalArgumentException if <code>anIndex</code> isn't an index node (primary node type name should be <code>sv:nodeIndex</code> or <code>sv:applicationIndex</code>)
+   */
+  setIndex(anIndex: Node): SearcherBuilder;
+
+  /**
+   * Sets the parser component.
+   *
+   * <p>
+   *    A <code>Parser</code> instance is created via the {@link ExtendedDismaxParserBuilder#build()} method
+   *    or the {@link StandardParserBuilder#build()} method.
+   * </p>
+   *
+   * <p>
+   *    <strong>Note!</strong> If no Parser is set, the <code>Searcher</code> that is constructed will use a <em>default multi-field
+   *    parser</em> (that can be constructed via {@link ExtendedDismaxParserBuilder}).
+   * </p>
+   * @param aParser the parser component
+   * @return this builder
+   * @see ExtendedDismaxParserBuilder
+   * @see StandardParserBuilder
+   */
+  setParser(aParser: Parser): SearcherBuilder;
+
+  /**
+   * Sets the sort component.
+   *
+   * <p>
+   *    A <code>Sort</code> instance is created via the {@link SortBuilder#build()} method.
+   * </p>
+   * @param aSort the sort component
+   * @return this builder
+   * @see SortBuilder
+   */
+  setSort(aSort: Sort): SearcherBuilder;
+
+  /**
+   * Sets the spell check (suggestions/did-you-mean) component.
+   *
+   * <p>
+   *    A <code>SpellCheck</code> instance is created via the {@link SpellCheckBuilder#build()} method.
+   * </p>
+   * @param aSpellCheck the spell check component
+   * @return this builder
+   * @see SpellCheckBuilder
+   */
+  setSpellCheck(aSpellCheck: SpellCheck): SearcherBuilder;
+
+  /**
+   * Sets the monitor component.
+   *
+   * <p>
+   *    A <code>Monitor</code> instance is created via the {@link MonitorBuilder#build()} method.
+   * </p>
+   * @param aMonitor the monitor component
+   * @return this builder
+   * @see MonitorBuilder
+   * @since Sitevision 4.1
+   */
+  setMonitor(aMonitor: Monitor): SearcherBuilder;
+
+  /**
+   * Creates a Searcher instance using currently specified components.
+   * @return a Searcher instance
+   */
+  build(): Searcher;
 }
 
+declare namespace SearcherBuilder {}
+
+declare var searcherBuilder: SearcherBuilder;
+
 export default searcherBuilder;