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

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

@@ -17,403 +17,6 @@ import Node from "../../../../../javax/jcr/Node";
  * <p>
  *    <em>This object is short lived in that sense that it is invalid after a specified timespan.
  *    Make sure it's handled correspondingly (i.e. do not cache it).</em>
- * </p><p>Checks if the value(-s) for a specified field contains a specific value.</p>
- *
- * <p>
- *    Convenience method to use when checking for a specific value. This method would typically be used when you are looking for a
- *    specific value in a <em>multi-valued</em> field. Typically <em>metadata</em> or a multi-valued default fields of the Sitevision
- *    standard/system index (e.g. <em>path</em> or <em>svtype</em>). Calling this method is more efficient than doing
- *    the contains check(-s) yourself (exemplified below):
- * </p>
- * <pre><code>
- *       boolean containsValue = false;
- *       List&lt;String&gt; fieldValues = aSearchHit.getFields("aFieldName");
- *       for (String fieldValue : fieldValues) {
- *          if (fieldValue.contains("a specific value")) {
- *             containsValue = true;
- *             break;
- *          }
- *       }</code></pre><p>Checks if the value(-s) for a specified field equals a specific value.</p>
- *
- * <p>
- *    Convenience method to use when checking for a specific value. This method would typically be used when you are looking for a
- *    specific value in a <em>multi-valued</em> field. Typically <em>metadata</em> or a multi-valued default fields of the Sitevision
- *    standard/system index (e.g. <em>path</em> or <em>svtype</em>). Calling this method is more efficient than doing
- *    the equals check(-s) yourself (exemplified below):
- * </p>
- * <pre><code>
- *       boolean equalsValue = false;
- *       List&lt;String&gt; fieldValues = aSearchHit.getFields("aFieldName");
- *       for (String fieldValue : fieldValues) {
- *          if (fieldValue.equals("a specific value")) {
- *             equalsValue = true;
- *             break;
- *          }
- *       }</code></pre>
- *
- * <p>
- *    <strong>An example:</strong>
- *    Your Site has a multi-valued metadata named "category" that is indexed
- *    (<em>the name of the stored, non-analyzed index field will be "metadata.category"</em>).
- *    The predefined set of selectable values for this metadata is "Internal", "External", "Personal", "Recreation", "Classified" and "Other".
- *    The page editors can select none or any combination of the predefined values for any node that is indexed.
- *    When rendering the search hits, you want to treat all search hits representing nodes that includes the "Classified" value for the
- *    "category" metadata differently. Below is an example that only handles the highlighted "summary" field for "non-Classified" hits:
- * </p>
- * <pre><code>
- *       for (SearchHit searchHit : searchResult) {
- *          ...
- *          if (!searchHit.fieldEquals("metadata.category", "Classfied")) {
- *             String summary = searchHit.getHighlightedField("summary", 500);
- *             ...
- *          }
- *          ...
- *       }</code></pre><p>Checks if the value(-s) for a specified field equals a specific value, case-insensitively.</p>
- *
- * <p>
- *    Convenience method to use when checking for a specific value, case-insensitively.
- *    This method would typically be used when you are looking for a
- *    specific value in a <em>multi-valued</em> field. Typically <em>metadata</em> or a multi-valued default fields of the Sitevision
- *    standard/system index (e.g. <em>path</em> or <em>svtype</em>). Calling this method is more efficient than doing
- *    the case-insensitive equals check(-s) yourself (exemplified below):
- * </p>
- * <pre><code>
- *       boolean equalsValue = false;
- *       List&lt;String&gt; fieldValues = aSearchHit.getFields("aFieldName");
- *       for (String fieldValue : fieldValues) {
- *          if (fieldValue.equalsIgnoreCase("a specific value")) {
- *             equalsValue = true;
- *             break;
- *          }
- *       }</code></pre>
- *
- * <p>
- *    <em>Note!</em> Always use the {@link #fieldEquals(String, String)} method instead when applicable!
- * </p><p>Checks if the value(-s) for a specified field matches a specified regular expression.</p>
- *
- * <p>
- *    Convenience method to use when checking for a specific value using a regular expression.
- *    This method would typically be used when you are looking for a
- *    specific pattern in a <em>multi-valued</em> field. Typically <em>metadata</em> or a multi-valued default fields of the Sitevision
- *    standard/system index (e.g. <em>path</em> or <em>svtype</em>). Calling this method is more efficient than doing
- *    the matches check(-s) yourself (exemplified below):
- * </p>
- * <pre><code>
- *       String regularExpression = "[a-zA-Z]+"; <em>// Chars 'a' to 'z' and 'A' to 'Z' one or more times...</em>
- *
- *       boolean matchesValue = false;
- *       List&lt;String&gt; fieldValues = aSearchHit.getFields("aFieldName");
- *       for (String fieldValue : fieldValues) {
- *          if (fieldValue.matches(regularExpression)) {
- *             matchesValue = true;
- *             break;
- *          }
- *       }</code></pre>
- *
- * <p>
- *    <strong>Note!</strong> This method creates, compiles and reuses <code>java.util.regex.Pattern</code> instances to improve matching
- *    performance for multiple values (typically when matching <em>multi-valued</em> field values). All such instances are cached in order to
- *    boost performance for subsequent calls to this method with the same <code>aRegularExpression</code>.
- * </p>
- *
- * <p>
- *    <em>Tip!</em> Regular expression syntax documentation is available via Oracle's
- *    <a href="http://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html">java.util.regex.Pattern</a> javadoc.
- * </p><p>Accesses the {@link javax.jcr.Node} corresponding to a {@link #TYPE_INTERNAL} hit. This
- * value will always be null for a {@link #TYPE_EXTERNAL} hit.</p><p>The indexed content as string for a specified field.</p>
- *
- * <p>
- *    <strong>Note!</strong> This method returns the content as string for the <em>first</em> field that matches <code>aFieldName</code>.
- *    No considerations are made regarding the field's type. The field value will be treated as a string.
- *    Calling this method is more efficient than calling <code>SearchHit.getField(aFieldName, false)</code> but the result will be equivalent.
- * </p>
- *
- * <p>
- *    For a <em>multi-valued</em> field, you would typically use {@link #getFields(String)} instead.
- * </p><p>The indexed content as XML escaped string for a specified field.</p>
- *
- * <p>
- *    This is a convenience method for {@link #getField(String)} that also XML escapes the result
- *    (see {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)}).
- *    A String that should be included in the html output should typically always be XML escaped to be valid XHTML and avoid XSS problems.
- * </p>
- * <p>
- *    This Velocity code:
- * </p>
- * <pre><code>
- *    #set ($endecUtil = $sitevisionUtils.endecUtil)
- *    ...
- *    &lt;p&gt;
- *       $endecUtil.escapeXML($searchHit.getField('title'))
- *    &lt;/p&gt;
- * </code></pre>
- * <p>
- *    would typically be replaced with this:
- * </p>
- * <pre><code>
- *    ...
- *    &lt;p&gt;
- *       $!searchHit.getFieldEscaped('title')
- *    &lt;/p&gt;
- * </code></pre>
- *
- * <p>
- *    <strong>This method can not be used to get field content of a highlighted field!</strong>
- *    Use {@link #getHighlightedField(String, int)} instead to get the XML escaped content of a highlighted field.
- * </p><p>The indexed content as string for a specified field, or a default value if no such field exist.</p>
- *
- * <p>
- *    <strong>Note!</strong> This is a convenience method for {@link #getField(String)} that enables you to avoid <code>null</code> checks.
- * </p><p>The indexed content as XML escaped string for a specified field, or a default value if no such field exist.</p>
- *
- * <p>
- *    This is a convenience method for {@link #getField(String, String)} that also XML escapes the result
- *    (see {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)}).
- *    A String that should be included in the html output should typically always be XML escaped to be valid XHTML and avoid XSS problems.
- * </p>
- * <p>
- *    This Velocity code:
- * </p>
- * <pre><code>
- *    #set ($endecUtil = $sitevisionUtils.endecUtil)
- *    ...
- *    &lt;p&gt;
- *       $endecUtil.escapeXML($searchHit.getField('title', ''))
- *    &lt;/p&gt;
- * </code></pre>
- * <p>
- *    would typically be replaced with this:
- * </p>
- * <pre><code>
- *    ...
- *    &lt;p&gt;
- *       $searchHit.getFieldEscaped('title', '')
- *    &lt;/p&gt;
- * </code></pre>
- *
- * <p>
- *    <strong>This method can not be used to get field content of a highlighted field!</strong>
- *    Use {@link #getHighlightedField(String, int)} instead to get the XML escaped content of a highlighted field.
- * </p><p>The indexed content as string for a specified field (with option to use first or largest field if multiple fields match).</p><p>The indexed content as XML escaped string for a specified field (with option to use first or largest field if multiple fields match).</p>
- *
- * <p>
- *    This is a convenience method for {@link #getField(String, boolean)} that also XML escapes the result
- *    (see {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)}).
- *    A String that should be included in the html output should typically always be XML escaped to be valid XHTML and avoid XSS problems.
- * </p>
- * <p>
- *    This Velocity code:
- * </p>
- * <pre><code>
- *    #set ($endecUtil = $sitevisionUtils.endecUtil)
- *    ...
- *    &lt;p&gt;
- *       $endecUtil.escapeXML($searchHit.getField('title', true))
- *    &lt;/p&gt;
- * </code></pre>
- * <p>
- *    would typically be replaced with this:
- * </p>
- * <pre><code>
- *    ...
- *    &lt;p&gt;
- *       $!searchHit.getFieldEscaped('title', true)
- *    &lt;/p&gt;
- * </code></pre>
- *
- * <p>
- *    <strong>This method can not be used to get field content of a highlighted field!</strong>
- *    Use {@link #getHighlightedField(String, int)} instead to get the XML escaped content of a highlighted field.
- * </p><p>
- *    The indexed content as string for a specified field (with option to use first or largest field if multiple fields match),
- *    or a default value if no such field exist.
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> This is a convenience method for {@link #getField(String, boolean)}
- *    that enables you to avoid <code>null</code> checks.
- * </p><p>
- *    The indexed content as XML escaped string for a specified field (with option to use first or largest field if multiple fields match),
- *    or a default value if no such field exist.
- * </p>
- *
- * <p>
- *    This is a convenience method for {@link #getField(String, boolean, String)} that also XML escapes the result
- *    (see {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)}).
- *    A String that should be included in the html output should typically always be XML escaped to be valid XHTML and avoid XSS problems.
- * </p>
- * <p>
- *    This Velocity code:
- * </p>
- * <pre><code>
- *    #set ($endecUtil = $sitevisionUtils.endecUtil)
- *    ...
- *    &lt;p&gt;
- *       $endecUtil.escapeXML($searchHit.getField('title', true, ''))
- *    &lt;/p&gt;
- * </code></pre>
- * <p>
- *    would typically be replaced with this:
- * </p>
- * <pre><code>
- *    ...
- *    &lt;p&gt;
- *       $searchHit.getFieldEscaped('title', true, '')
- *    &lt;/p&gt;
- * </code></pre>
- *
- * <p>
- *    <strong>This method can not be used to get field content of a highlighted field!</strong>
- *    Use {@link #getHighlightedField(String, int)} instead to get the XML escaped content of a highlighted field.
- * </p><p>The indexed content as a list of strings for a specified field.</p>
- *
- * <p>
- *    This method would typically be used for <em>multi-valued</em> fields. For a single-valued String field, you would typically use
- *    {@link #getField(String)} instead. No considerations are made regarding the field's type. The field values will be treated as strings.
- * </p>
- * <p>
- *    <strong>Note!</strong> If the field is highlighted, use {@link #getHighlightedFields(String, int)} instead.
- * </p><p>The indexed content as a list of XML escaped strings for a specified field.</p>
- *
- * <p>
- *    This is a convenience method for {@link #getFields(String)} that also XML escapes the result
- *    (see {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)}).
- *    A String that should be included in the html output should typically always be XML escaped to be valid XHTML and avoid XSS problems.
- * </p>
- *
- * <p>
- *    <strong>This method can not be used to get field content of a highlighted field!</strong>
- *    Use {@link #getHighlightedFields(String, int)} instead to get the XML escaped content of a highlighted field.
- * </p><p>The indexed content as a list of lenient truncated strings for a specified field.</p>
- *
- * <p>
- *    This method would typically be used for <em>multi-valued</em> fields. For a single-valued String field, you would typically use
- *    {@link #getFieldTruncated(String, int)} instead. No considerations are made regarding the field's type.
- *    The field values will be treated as strings.
- * </p>
- * <p>
- *    <strong>Note!</strong> If the field is highlighted, use {@link #getHighlightedFields(String, int)} instead.
- * </p>
- * <p>
- *    <em>Calling this method is is equivalent to calling <code>SearchHit.getFieldsTruncated(aFieldName, maxContentLength, true)</code>.</em>
- * </p><p>The indexed content as a list of truncated (lenient or not) strings for a specified field.</p>
- *
- * <p>
- *    This method would typically be used for <em>multi-valued</em> fields. For a single-valued String field, you would typically use
- *    {@link #getFieldTruncated(String, int)} instead. No considerations are made regarding the field's type.
- *    The field values will be treated as strings.
- * </p>
- * <p>
- *    <strong>Note!</strong> If the field is highlighted, use {@link #getHighlightedFields(String, int)} instead.
- * </p><p>The indexed content as Boolean for a specified field.</p>
- *
- * <p>
- *    <strong>Note!</strong> This method returns the content as Boolean for the <em>first</em> field that matches <code>aFieldName</code>.
- * </p><p>The indexed contents as a list of Boolean values for a specified field.</p>
- *
- * <p>
- *    This method would typically be used for <em>multi-valued</em> fields. For a single-valued field, you would typically use
- *    {@link #getBooleanField(String)} instead.
- * </p><p>The indexed content as Date for a specified field.</p>
- *
- * <p>
- * <strong>Note!</strong> This method returns the content as Date for the <em>first</em> field that matches <code>aFieldName</code>.
- * </p><p>The indexed contents as a list of Date values for a specified field.</p>
- *
- * <p>
- *    This method would typically be used for <em>multi-valued</em> Date fields. For a single-valued Date field, you would typically use
- *    {@link #getDateField(String)} instead.
- * </p><p>The indexed content as Float for a specified field.</p>
- *
- * <p>
- *    <strong>Note!</strong> This method returns the content as Float for the <em>first</em> field that matches <code>aFieldName</code>.
- * </p><p>The indexed contents as a list of Float values for a specified field.</p>
- *
- * <p>
- *    This method would typically be used for <em>multi-valued</em> Float fields. For a single-valued Float field, you would typically use
- *    {@link #getFloatField(String)} instead.
- * </p><p>The indexed content as Long for a specified field.</p>
- *
- * <p>
- *    <strong>Note!</strong> This method returns the content as Long for the <em>first</em> field that matches <code>aFieldName</code>.
- * </p><p>The indexed contents as a list of Long values for a specified field.</p>
- *
- * <p>
- *    This method would typically be used for <em>multi-valued</em> Long fields. For a single-valued Long field, you would typically use
- *    {@link #getLongField(String)} instead.
- * </p><p>The encoded and highlighted content of a highlighted field.</p>
- *
- * <p>
- *    <strong>Note!</strong> The result of this method is <em>always</em> escaped/encoded to XML entities so it won't interfere with the html
- *    elements that surround the possible "highlighted" fragments!
- * </p><p>The encoded and highlighted contents of a highlighted field.</p>
- *
- * <p>
- *    This method would typically be used for <em>multi-valued</em> highlighted fields. For a single-valued highlighted field
- *    (or if you only are interested in the largest highlighted value), you would typically use {@link #getHighlightedField(String, int)} instead.
- *    No considerations are made regarding the field's type. The field values will be treated as strings.
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> The items in the result of this method is <em>always</em> escaped/encoded to XML entities so they won't interfere
- *    with the html elements that surround the possible "highlighted" fragments!
- * </p><p>The indexed content as string for a specified field, truncated to a lenient max size.</p>
- *
- * <p>
- *    <strong>Note!</strong> Calling this method is is equivalent to calling
- *    <code>SearchHit.getFieldTruncated(aFieldName, true, true, maxContentLength)</code>.
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> If the field is highlighted, use {@link #getHighlightedField(String, int)} instead.
- * </p><p>
- *    The indexed content as string for a specified field, truncated (lenient or not) to a max size and an option to use first
- *    or largest field if multiple fields match.
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> If the field is highlighted, use {@link #getHighlightedField(String, int)} instead.
- * </p>The names of all fields available in this search hit.
- *
- * <p>
- *    <em>Potentially also includes the Solr pseudo fields "score" and "[elevated]".</em>
- * </p>The relative search score of the hit.
- *
- * <p>
- *    The value ranges from 0 to 1 where 1 denotes the maximum score.
- *    Note that the first hit does not necessarily has score 1, it is just the hit with the
- *    highest relative score in the {@link SearchResult}.
- * </p>
- *
- * <p>
- *    <em>
- *       This method depends on availability of the Solr score pseudo field.
- *       Search queries without that field will always return 0,
- *    </em>
- * </p>
- *
- * <p>
- *    <strong>Tip!</strong> Use this method to see the scores of your hits when debugging and tuning search field boost weights et al.
- * </p>Whether or not the search hit was elevated in the query result.
- *
- * <p>
- *    <em>
- *       This method depends on availability of the Solr [elevated] pseudo field.
- *       Search queries without that field will always return false,
- *       typically when custom fields (the Solr 'fl' param) is specified.
- *    </em>
- * </p><p>The type of <code>SearchHit</code> object.</p>Returns a jQuery expression with a token that enables tracking of search hit clicks.
- *
- * <p>
- *    Tracking search hits clicks is a helpful tool when analyzing if visitors seems to find interesting information in their search results.
- *    Though, if the search result isn't really inited by the user (i.e. an A-Z listing or such), adding a click tracking callback is probably
- *    not a good idea.
- * </p>
- *
- * <p>
- *    A click tracking callback would typically be applied as value for the "onclick" and "onkeypress" attributes of a search hit link.
- *    When rendering links to search hits with the {@link senselogic.sitevision.api.render.LinkRenderer}, apply the click tracking callback via
- *    {@link senselogic.sitevision.api.render.LinkRenderer#setOnclick(String)}
  * </p><p>Indicates that the hit is an internal resource managed by the Sitevision server</p><p>Indicates that the hit is an external resource</p>
  * @author Mikael Wikblom
  * @since Sitevision 2.6_06
@@ -836,7 +439,7 @@ interface SearchHit {
    * @see #getFieldsTruncated(String, int)
    * @since Sitevision 3.0.3
    */
-  getFields(aFieldName: string): unknown[];
+  getFields(aFieldName: string): unknown;
 
   /**
    * <p>The indexed content as a list of XML escaped strings for a specified field.</p>
@@ -856,7 +459,7 @@ interface SearchHit {
    * @see #getFields(String)
    * @since Sitevision 4
    */
-  getFieldsEscaped(aFieldName: string): unknown[];
+  getFieldsEscaped(aFieldName: string): unknown;
 
   /**
    * <p>The indexed content as a list of lenient truncated strings for a specified field.</p>
@@ -878,7 +481,7 @@ interface SearchHit {
    * @see #getFieldsTruncated(String, int, boolean)
    * @since Sitevision 3.0.3
    */
-  getFieldsTruncated(aFieldName: string, maxContentLength: number): unknown[];
+  getFieldsTruncated(aFieldName: string, maxContentLength: number): unknown;
 
   /**
    * <p>The indexed content as a list of truncated (lenient or not) strings for a specified field.</p>
@@ -902,7 +505,7 @@ interface SearchHit {
     aFieldName: string,
     maxContentLength: number,
     useLenientTruncation: boolean
-  ): unknown[];
+  ): unknown;
 
   /**
    * <p>The indexed content as Boolean for a specified field.</p>
@@ -929,7 +532,7 @@ interface SearchHit {
    * @see #getBooleanField(String)
    * @since Sitevision 3.0.3
    */
-  getBooleanFields(aFieldName: string): unknown[];
+  getBooleanFields(aFieldName: string): unknown;
 
   /**
    * <p>The indexed content as Date for a specified field.</p>
@@ -956,7 +559,7 @@ interface SearchHit {
    * @see #getDateField(String)
    * @since Sitevision 3.0.3
    */
-  getDateFields(aFieldName: string): unknown[];
+  getDateFields(aFieldName: string): unknown;
 
   /**
    * <p>The indexed content as Float for a specified field.</p>
@@ -983,7 +586,7 @@ interface SearchHit {
    * @see #getFloatField(String)
    * @since Sitevision 3.0.3
    */
-  getFloatFields(aFieldName: string): unknown[];
+  getFloatFields(aFieldName: string): unknown;
 
   /**
    * <p>The indexed content as Long for a specified field.</p>
@@ -1010,7 +613,7 @@ interface SearchHit {
    * @see #getLongField(String)
    * @since Sitevision 3.0.3
    */
-  getLongFields(aFieldName: string): unknown[];
+  getLongFields(aFieldName: string): unknown;
 
   /**
    * <p>The encoded and highlighted content of a highlighted field.</p>
@@ -1052,7 +655,7 @@ interface SearchHit {
   getHighlightedFields(
     aFieldName: string,
     maxNonHighlightedLength: number
-  ): unknown[];
+  ): unknown;
 
   /**
    * <p>The indexed content as string for a specified field, truncated to a lenient max size.</p>

package/hidden/senselogic/sitevision/api/search/SearchHit/index.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  fieldContains: function fieldContains() {},
+  fieldEquals: function fieldEquals() {},
+  fieldEqualsIgnoreCase: function fieldEqualsIgnoreCase() {},
+  fieldMatches: function fieldMatches() {},
+  getNode: function getNode() {},
+  getField: function getField() {},
+  getFieldEscaped: function getFieldEscaped() {},
+  getFields: function getFields() {},
+  getFieldsEscaped: function getFieldsEscaped() {},
+  getFieldsTruncated: function getFieldsTruncated() {},
+  getBooleanField: function getBooleanField() {},
+  getBooleanFields: function getBooleanFields() {},
+  getDateField: function getDateField() {},
+  getDateFields: function getDateFields() {},
+  getFloatField: function getFloatField() {},
+  getFloatFields: function getFloatFields() {},
+  getLongField: function getLongField() {},
+  getLongFields: function getLongFields() {},
+  getHighlightedField: function getHighlightedField() {},
+  getHighlightedFields: function getHighlightedFields() {},
+  getFieldTruncated: function getFieldTruncated() {},
+  getFieldNames: function getFieldNames() {},
+  getScore: function getScore() {},
+  isElevated: function isElevated() {},
+  getType: function getType() {},
+  getClickTrackingCallback: function getClickTrackingCallback() {}
+};
+exports["default"] = _default;