@sitevision/api 1.0.20 → 1.1.0-alpha.1

package/server/SimpleUserUtil/index.d.ts

@@ -1,42 +1,51 @@
-import Node from '../../builtins/Node';
-
-export interface SimpleUserUtil {
-  /**
-   * Checks if current user is member of a virtual group with a specific id.
-   * @param {string} aVirtualGroupId - id of a virtual group (sv:virtualGroup). Note! The id of a virtual group does not always match the name of the virtual group.
-   * @returns {boolean} true if current user is member of the virtual group resolved via aVirtualGroupId,false otherwise 
-   */
-  isMemberOfVirtualGroup(aVirtualGroupId: string): boolean;
-
-  /**
-   * Checks if a simple user is member of a virtual group with a specific id.
-   * @param {Node} aSimpleUser - a simple user node (sv:simpleUser)
-   * @param {string} aVirtualGroupId - id of a virtual group (sv:virtualGroup). Note! The id of a virtual group does not always match the name of the virtual group.
-   * @returns {boolean} true if aSimpleUser is member of the virtual group resolved via aVirtualGroupId,false otherwise 
-   */
-  isMemberOfVirtualGroup(aSimpleUser: Node, aVirtualGroupId: string): boolean;
-}
+import Node from "../../hidden/javax/jcr/Node";
 
 /**
  * Checks if current user is member of a virtual group with a specific id.
- * @param {string} aVirtualGroupId - id of a virtual group (sv:virtualGroup). Note! The id of a virtual group does not always match the name of the virtual group.
- * @returns {boolean} true if current user is member of the virtual group resolved via aVirtualGroupId,false otherwise 
+ *
+ * <p>
+ *    This is a convenience for {@link #isMemberOfVirtualGroup(javax.jcr.Node, String)} using current user
+ *    (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).
+ * </p>
+ * @param aVirtualGroupId id of a virtual group (sv:virtualGroup). Note! The <em>id</em> of a virtual group does not always match the <em>name</em> of the virtual group.
+ * @return <code>true</code> if current user is member of the virtual group resolved via <code>aVirtualGroupId</code>, <code>false</code> otherwise
+ * @see senselogic.sitevision.api.user.UserUtil#isMemberOfGroup(javax.jcr.Node)
  */
 export function isMemberOfVirtualGroup(aVirtualGroupId: string): boolean;
 
 /**
  * Checks if a simple user is member of a virtual group with a specific id.
- * @param {Node} aSimpleUser - a simple user node (sv:simpleUser)
- * @param {string} aVirtualGroupId - id of a virtual group (sv:virtualGroup). Note! The id of a virtual group does not always match the name of the virtual group.
- * @returns {boolean} true if aSimpleUser is member of the virtual group resolved via aVirtualGroupId,false otherwise 
+ * @param aSimpleUser a simple user node (sv:simpleUser)
+ * @param aVirtualGroupId id of a virtual group (sv:virtualGroup). Note! The <em>id</em> of a virtual group does not always match the <em>name</em> of the virtual group.
+ * @return <code>true</code> if <code>aSimpleUser</code> is member of the virtual group resolved via <code>aVirtualGroupId</code>, <code>false</code> otherwise
+ * @see senselogic.sitevision.api.user.UserUtil#isMemberOfGroup(javax.jcr.Node, javax.jcr.Node)
  */
-export function isMemberOfVirtualGroup(aSimpleUser: Node, aVirtualGroupId: string): boolean;
+export function isMemberOfVirtualGroup(
+  aSimpleUser: Node,
+  aVirtualGroupId: string
+): boolean;
 
-declare namespace simpleUserUtil {
-  export {
-    isMemberOfVirtualGroup,
-  };
+/**
+ * Simple user utility interface.
+ *
+ * <p>
+ *    This interface handles nodes with primary node type <code>sv:simpleUser</code>.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link UserFactory#getSimpleUserUtil()}.
+ *    See {@link senselogic.sitevision.api.user.UserFactory} for how to obtain an instance of the <code>UserFactory</code> interface.
+ * </p>Checks if current user is member of a virtual group with a specific id.
+ *
+ * <p>
+ *    This is a convenience for {@link #isMemberOfVirtualGroup(javax.jcr.Node, String)} using current user
+ *    (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).
+ * </p>Checks if a simple user is member of a virtual group with a specific id.
+ * @author Magnus Lövgren
+ * @since Sitevision 4.0.1
+ */
+declare namespace SimpleUserUtil {
+  export { isMemberOfVirtualGroup };
 }
 
-export default simpleUserUtil;
-
+export default SimpleUserUtil;

package/server/SiteCookieUtil/index.d.ts

@@ -1,127 +1,129 @@
-import Node from '../../builtins/Node';
-import List from '../../builtins/List';
+import Node from "../../hidden/javax/jcr/Node";
 
 /**
  * Necessary Site cookies (sv:siteCookie) of current site.
- *
- * @return {List<Node>} the necessary site cookies of current site, or empty list if current site has no site cookies
+ * @return the necessary site cookies of current site, or empty list if current site has no site cookies
  */
-export function getNecessarySiteCookies(): List<Node>;
+export function getNecessarySiteCookies(): unknown[];
 
 /**
  * Gets the necessary site cookies category title.
- *
- * @return {string} necessary site cookies category title
+ * @return necessary site cookies category title
  */
 export function getNecessarySiteCookiesTitle(): string;
 
 /**
  * Gets the necessary site cookies category description.
- *
- * @return {string} necessary site cookies category description
+ * @return necessary site cookies category description
  */
 export function getNecessarySiteCookiesDescription(): string;
 
 /**
  * Analytics Site cookies (sv:siteCookie) of current site.
- *
- * @return {List<Node>} the analytics site cookies of current site, or empty list if current site has no site cookies
+ * @return the analytics site cookies of current site, or empty list if current site has no site cookies
  */
-export function getAnalyticsSiteCookies(): List<Node>;
+export function getAnalyticsSiteCookies(): unknown[];
 
 /**
  * Gets the analytics site cookies category title.
- *
- * @return {string} analytics site cookies category title
+ * @return analytics site cookies category title
  */
 export function getAnalyticsSiteCookiesTitle(): string;
 
 /**
  * Gets the analytics site cookies category description.
- *
- * @return {string} analytics site cookies category description
+ * @return analytics site cookies category description
  */
 export function getAnalyticsSiteCookiesDescription(): string;
 
 /**
  * Marketing Site cookies (sv:siteCookie) of current site.
- *
- * @return {List<Node>} the marketing site cookies of current site, or empty list if current site has no site cookies
+ * @return the marketing site cookies of current site, or empty list if current site has no site cookies
  */
-export function getMarketingSiteCookies(): List<Node>;
+export function getMarketingSiteCookies(): unknown[];
 
 /**
  * Gets the marketing site cookies category title.
- *
- * @return {string} marketing site cookies category title
+ * @return marketing site cookies category title
  */
 export function getMarketingSiteCookiesTitle(): string;
 
 /**
  * Gets the marketing site cookies category description.
- *
- * @return {string} marketing site cookies category description
+ * @return marketing site cookies category description
  */
 export function getMarketingSiteCookiesDescription(): string;
 
+/**
+ * Functional Site cookies (sv:siteCookie) of current site.
+ * @return the functional site cookies of current site, or empty list if current site has no site cookies
+ * @since Sitevision 9.1.1
+ */
+export function getFunctionalSiteCookies(): unknown[];
+
+/**
+ * Gets the functional site cookies category title.
+ * @return functional site cookies category title
+ * @since Sitevision 9.1.1
+ */
+export function getFunctionalSiteCookiesTitle(): string;
+
+/**
+ * Gets the functional site cookies category description.
+ * @return functional site cookies category description
+ * @since Sitevision 9.1.1
+ */
+export function getFunctionalSiteCookiesDescription(): string;
+
 /**
  * Custom Site cookies (sv:siteCookie) of current site.
- *
- * @return {List<Node>} the custom site cookies of current site, or empty list if current site has no site cookies
+ * @return the custom site cookies of current site, or empty list if current site has no site cookies
  */
-export function getCustomSiteCookies(): List<Node>;
+export function getCustomSiteCookies(): unknown[];
 
 /**
  * Gets the custom site cookies category title.
- *
- * @return {string} custom site cookies category title
+ * @return custom site cookies category title
  */
 export function getCustomSiteCookiesTitle(): string;
 
 /**
  * Gets the custom site cookies category description.
- *
- * @return {string} custom site cookies category description
+ * @return custom site cookies category description
  */
 export function getCustomSiteCookiesDescription(): string;
 
 /**
  * Convenience method that resolves a sv:siteCookie Node from a given cookie identifier.
- *
- * @param {string} aCookieIdentifier the site cookie identifier
- * @return {Node} the sv:siteCookie Node with the "cookieIdentifier" property that matches aCookieIdentifier. Returns null if
- * aCookieIdentifier is null, blank or indeterminable
+ * @param aCookieIdentifier the site cookie identifier
+ * @return the sv:siteCookie Node with the "cookieIdentifier" property that matches aCookieIdentifier. Returns null if aCookieIdentifier is null, blank or indeterminable
  */
 export function resolveSiteCookieByIdentifier(aCookieIdentifier: string): Node;
 
 /**
  * Checks whether or not current user explicitly has accepted a specific site cookie.
- *
- * @param {Node} aSiteCookie the sv:siteCookie
- * @return {boolean} true if current user has accepted aSiteCookie, false otherwise
+ * @param aSiteCookie the sv:siteCookie
+ * @return true if current user has accepted aSiteCookie, false otherwise
  */
-export function checkUserConsent(aSiteCookie: Node);
+export function checkUserConsent(aSiteCookie: Node): boolean;
 
 /**
  * Whether or not current user has explicitly accepted/rejected all "user selectable" site cookies.
- *
- * @return {boolean} true if there are site cookies that current user hasn't yet accepted/rejected, false otherwise
+ * @return true if there are site cookies that current user hasn't yet accepted/rejected, false otherwise
  * @see #hasUserConsentCookie()
  */
 export function hasPendingUserConsents(): boolean;
 
 /**
  * Whether or not current user has a consent cookie.
- *
- * @return {boolean} true if current user has a consent cookie set, false otherwise
+ * @return true if current user has a consent cookie set, false otherwise
  * @see #hasPendingUserConsents()
  */
 export function hasUserConsentCookie(): boolean;
 
 /**
  * The name of the cookie that contains data about site cookie consents.
- *
- * @return {string} the name of the cookie that contains data about site cookie consents
+ * @return the name of the cookie that contains data about site cookie consents
  */
 export function getUserConsentCookieName(): string;
 
@@ -132,24 +134,42 @@ export function getUserConsentCookieName(): string;
  *    <em>Note!</em> All "user selectable" sv:siteCookie Nodes that are <em>not</em> present in <code>aAllowCookieIdList</code>
  *    will be treated as rejected.
  * </p>
- *
- * @param {List<Node>} aAllowCookieIdList the list of sv:siteCookie accepted by current user
- * @return {string} a string that represents the accept/reject status for current sv:siteCookie's
+ * @param aAllowCookieIdList the list of sv:siteCookie accepted by current user
+ * @return a string that represents the accept/reject status for current sv:siteCookie's
  * @throws IllegalArgumentException if aAllowCookieIdList is null or contains other than sv:siteCookie Nodes
  */
 export function createUserConsentCookieValue(
-  aAllowCookieIdList: List<Node>
+  aAllowCookieIdList: unknown[]
 ): string;
 
 /**
  * Gets all sv:siteCookie nodes that current user has accepted.
- *
- * @return {List<Node>} the list of sv:siteCookie Nodes current user has accepted. Returns empty list if site has no site cookies or if current user hasn't
- * accepted any sv:siteCookie
+ * @return the list of sv:siteCookie Nodes current user has accepted. Returns empty list if site has no site cookies or if current user hasn't accepted any sv:siteCookie
  */
-export function getUserConsents(): List<Node>;
+export function getUserConsents(): unknown[];
 
-declare namespace siteCookieUtil {
+/**
+ * Site cookie utility interface.
+ *
+ * <p>
+ *    Contains methods for retrieving sv:siteCookie Nodes of current site and current user's consent status of them.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getSiteCookieUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Necessary Site cookies (sv:siteCookie) of current site.Gets the necessary site cookies category title.Gets the necessary site cookies category description.Analytics Site cookies (sv:siteCookie) of current site.Gets the analytics site cookies category title.Gets the analytics site cookies category description.Marketing Site cookies (sv:siteCookie) of current site.Gets the marketing site cookies category title.Gets the marketing site cookies category description.Functional Site cookies (sv:siteCookie) of current site.Gets the functional site cookies category title.Gets the functional site cookies category description.Custom Site cookies (sv:siteCookie) of current site.Gets the custom site cookies category title.Gets the custom site cookies category description.Convenience method that resolves a sv:siteCookie Node from a given cookie identifier.Checks whether or not current user explicitly has accepted a specific site cookie.Whether or not current user has explicitly accepted/rejected all "user selectable" site cookies.Whether or not current user has a consent cookie.The name of the cookie that contains data about site cookie consents.Generates a consent string that can be saved as cookie value for the cookie named {@link #getUserConsentCookieName()}.
+ *
+ * <p>
+ *    <em>Note!</em> All "user selectable" sv:siteCookie Nodes that are <em>not</em> present in <code>aAllowCookieIdList</code>
+ *    will be treated as rejected.
+ * </p>Gets all sv:siteCookie nodes that current user has accepted.
+ * @see senselogic.sitevision.api.resource.ResourceLocatorUtil#getSiteCookieRepository()
+ * @author Karl Eklöf
+ * @since Sitevision 9.1
+ */
+declare namespace SiteCookieUtil {
   export {
     getNecessarySiteCookies,
     getNecessarySiteCookiesTitle,
@@ -160,6 +180,9 @@ declare namespace siteCookieUtil {
     getMarketingSiteCookies,
     getMarketingSiteCookiesTitle,
     getMarketingSiteCookiesDescription,
+    getFunctionalSiteCookies,
+    getFunctionalSiteCookiesTitle,
+    getFunctionalSiteCookiesDescription,
     getCustomSiteCookies,
     getCustomSiteCookiesTitle,
     getCustomSiteCookiesDescription,
@@ -172,3 +195,5 @@ declare namespace siteCookieUtil {
     getUserConsents,
   };
 }
+
+export default SiteCookieUtil;

package/server/SortBuilder/index.d.ts

@@ -0,0 +1,111 @@
+import SearchSortField from "../../hidden/senselogic/sitevision/api/search/SearchSortField";
+import Sort from "../../hidden/senselogic/sitevision/api/search/searcher/component/Sort";
+
+/**
+ * Adds a sort field.
+ * @param aSearchSortField a sort field, a <code>null</code> value is ignored
+ * @return this builder
+ */
+export function addSortField(aSearchSortField: SearchSortField): SortBuilder;
+
+/**
+ * Removes all previously added sort fields.
+ * @return this builder
+ */
+export function clearSortFields(): SortBuilder;
+
+/**
+ * Creates a Sort component instance using currently specified state/behaviour.
+ * @return a Sort component
+ * @throws IllegalStateException if no sort fields are added
+ */
+export function build(): Sort;
+
+/**
+ * <p>
+ *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.Sort} component with specific behaviour.
+ * </p>
+ *
+ * <p>
+ *    SortBuilder has one <strong>mandatory attribute</strong>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       <em>sort fields</em> - The sort field(s) that should be used to sort a search result. Must be non-null.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    Using the SortBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
+ *    would typically use it like this:
+ * </p>
+ * <ol>
+ *   <li>Get the SortBuilder</li>
+ *   <li>Create a SearchSortField</li>
+ *   <li>Add the SearchSortField to the SortBuilder</li>
+ *   <li>Possibly create another SearchSortField and add it to the SortBuilder</li>
+ *   <li>Do build</li>
+ * </ol>
+ * <p>
+ *    When you have built a <code>Sort</code> instance, you can re-use the SortBuilder to build more instances. Typically like:
+ * </p>
+ * <ol>
+ *   <li>Clear the sort fields</li>
+ *   <li>Create a SearchSortField and add it to the SortBuilder</li>
+ *   <li>Possibly create another SearchSortField and add it to the SortBuilder</li>
+ *   <li>Do build</li>
+ * </ol>
+ *
+ * <p>
+ *    <strong>Example of how this strategy could be implemented in sever-side Javascript:</strong>
+ * </p>
+ * <pre><code>   <em>// Get the factory and the builder</em>
+ *   var searchFactory = require('SearchFactory'),
+ *       sortBuilder = searchFactory.getSortBuilder(),
+ *       searchSortField,
+ *       updatedDescSort,
+ *       nameAscSort;
+ *
+ *   <em>// Create a Sort</em>
+ *   searchSortField = searchFactory.getSearchSortField('lastpublished', false);
+ *   updatedDescSort = sortBuilder.addSortField(searchSortField).build();
+ *
+ *   <em>// Re-use the builder to create another Sort</em>
+ *   searchSortField = searchFactory.getSearchSortField('name.sortable', true);
+ *   nameAscSort = sortBuilder.clearSortFields().addSortField(searchSortField).build();
+ * </code></pre>
+ *
+ * <p>
+ *    <strong>Example of how this strategy could be implemented in Velocity:</strong>
+ * </p>
+ * <pre><code>   <em>## Get the factory and the builder</em>
+ *   #set ($searchFactory = $sitevisionUtils.searchFactory)
+ *   #set ($sortBuilder = $searchFactory.sortBuilder)
+ *
+ *   <em>## Create a Sort</em>
+ *   #set ($searchSortField = $searchFactory.getSearchSortField('lastpublished', false))
+ *   #set ($updatedDescSort = $sortBuilder.addSortField($searchSortField).build())
+ *
+ *   <em>## Re-use the builder to create another Sort</em>
+ *   #set ($searchSortField = $searchFactory.getSearchSortField('name.sortable', true))
+ *   #set ($nameAscSort = $sortBuilder.clearSortFields().addSortField($searchSortField).build())
+ * </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>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.SearchFactory#getSortBuilder()}.
+ *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
+ * </p>Adds a sort field.Removes all previously added sort fields.Creates a Sort component instance using currently specified state/behaviour.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+declare namespace SortBuilder {
+  export { addSortField, clearSortFields, build };
+}
+
+export default SortBuilder;

package/server/SpellCheckBuilder/index.d.ts

@@ -0,0 +1,68 @@
+import SpellCheck from "../../hidden/senselogic/sitevision/api/search/searcher/component/SpellCheck";
+
+/**
+ * Sets a custom query/expression spellchecker should use when the extracting result.
+ *
+ * <p>
+ *    The <em>display query</em> is used by {@link senselogic.sitevision.api.search.searcher.Searcher} as default spellcheck query
+ *    (i.e. if no custom value is set via this method).
+ * </p>
+ *
+ * <p>
+ *    <em>Solr note: this is the 'spellcheck.q' param</em>
+ * </p>
+ * @param aCustomSpellCheckQuery the custom query/expression <em>(Note that a <code>null</code> or whitespace-only value will be ignored by {@link senselogic.sitevision.api.search.searcher.Searcher}).</em>
+ * @return this builder
+ * @since Sitevision 4.0
+ */
+export function setCustomSpellCheckQuery(
+  aCustomSpellCheckQuery: string
+): SpellCheckBuilder;
+
+/**
+ * Creates a SpellCheck component instance.
+ * @return a SpellCheck component.
+ */
+export function build(): SpellCheck;
+
+/**
+ * <p>
+ *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.SpellCheck} component.
+ * </p>
+ *
+ * <p>
+ *    SpellCheckBuilder has one <em>optional</em> attribute:
+ * </p>
+ * <ul>
+ *    <li>
+ *       <em>custom spellcheck query</em> - A custom expression/query to use when extracting "did you mean" suggestions.
+ *    </li>
+ * </ul>
+ *
+ * <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>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.SearchFactory#getSpellCheckBuilder()}.
+ *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
+ * </p>Sets a custom query/expression spellchecker should use when the extracting result.
+ *
+ * <p>
+ *    The <em>display query</em> is used by {@link senselogic.sitevision.api.search.searcher.Searcher} as default spellcheck query
+ *    (i.e. if no custom value is set via this method).
+ * </p>
+ *
+ * <p>
+ *    <em>Solr note: this is the 'spellcheck.q' param</em>
+ * </p>Creates a SpellCheck component instance.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+declare namespace SpellCheckBuilder {
+  export { setCustomSpellCheckQuery, build };
+}
+
+export default SpellCheckBuilder;

package/server/StandardParserBuilder/index.d.ts

@@ -0,0 +1,112 @@
+import Parser from "../../hidden/senselogic/sitevision/api/search/searcher/component/Parser";
+
+/**
+ * Sets the default query field.
+ *
+ * <p>
+ *    <em>Solr note: this is the 'df' param.</em>
+ * </p>
+ * @param aDefaultField the name of the query field, <code>null</code> or whitespace-only values will be ignored
+ * @return this builder
+ */
+export function setDefaultField(aDefaultField: string): StandardParserBuilder;
+
+/**
+ * Sets the query operator.
+ *
+ * <p>
+ *    <em>Solr note: this is the 'q.op' param. The value should typically be "AND" or "OR".</em>
+ * </p>
+ * @param aQueryOperator the query operator, all values except [null, "AND", "OR"] will be ignored
+ * @return this builder
+ * @since Sitevision 4.0.2
+ */
+export function setQueryOperator(aQueryOperator: string): StandardParserBuilder;
+
+/**
+ * Creates a Parser component instance using currently specified state/behaviour.
+ * @return a Parser component.
+ */
+export function build(): Parser;
+
+/**
+ * <p>
+ *    Builder for creating a single-field {@link senselogic.sitevision.api.search.searcher.component.Parser} component with specific behaviour.
+ * </p>
+ *
+ * <p>
+ *    StandardParserBuilder has two <strong>optional attributes</strong>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       <em>default field (df)</em> - The field to query. Default is the field specified by the index configuration.
+ *       <em>
+ *          (Default field for the default Node index is <code>content.analyzed</code>)
+ *       </em>
+ *    </li>
+ *    <li>
+ *       <em>query operator (q.op)</em> - The query operator. Default is the operator specified by the index configuration.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    Using the StandardParserBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
+ *    would typically use it like this:
+ * </p>
+ * <ol>
+ *   <li>Get the StandardParserBuilder</li>
+ *   <li>Possibly set the default field</li>
+ *   <li>Do build</li>
+ * </ol>
+ * <p>
+ *    When you have built a <code>Parser</code> instance, you can re-use the StandardParserBuilder to build more instances. Typically like:
+ * </p>
+ * <ol>
+ *   <li>(Re-)set the default field</li>
+ *   <li>Do build</li>
+ * </ol>
+ * <p>
+ *    <strong>Example of how this strategy could be implemented in Velocity:</strong>
+ * </p>
+ * <pre><code>
+ *   <em>## Get the builder</em>
+ *   #set ($searchFactory = $sitevisionUtils.searchFactory)
+ *   #set ($standardBuilder = $searchFactory.standardParserBuilder)
+ *
+ *   <em>## Create a Parser</em>
+ *   #set ($nameFieldParser = $standardBuilder.setDefaultField('name.analyzed').build())
+ *
+ *   <em>## Re-use the builder to create another Parser</em>
+ *   #set ($titleFieldParser = $standardBuilder.setDefaultField('title.analyzed').build())
+ * </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>
+ *    <em>Solr note: the defType param for this parser is 'standard' or 'lucene'</em>
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.SearchFactory#getStandardParserBuilder()}.
+ *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
+ * </p>Sets the default query field.
+ *
+ * <p>
+ *    <em>Solr note: this is the 'df' param.</em>
+ * </p>Sets the query operator.
+ *
+ * <p>
+ *    <em>Solr note: this is the 'q.op' param. The value should typically be "AND" or "OR".</em>
+ * </p>Creates a Parser component instance using currently specified state/behaviour.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+declare namespace StandardParserBuilder {
+  export { setDefaultField, setQueryOperator, build };
+}
+
+export default StandardParserBuilder;