@sitevision/api 1.0.19 → 1.1.0-alpha.1

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

@@ -0,0 +1,89 @@
+/**
+ * Utility class for converting String values extracted from search fields.
+ *
+ * <p>
+ *    <strong>Note!</strong> {@link senselogic.sitevision.api.search.SearchHit} has - as of Sitevision 3.0 - several typed <code>getField</code>
+ *    methods that you would typically instead of this interface when you want to get "non-String" values!
+ *    <a href="../../../../senselogic/sitevision/api/search/SearchHit.html#knowyourfields">More information about field values/types</a>
+ * </p>Returns the Date for a string field that contains a date value generated via Lucene's DateTools class.Returns the Calendar for a string field that contains a date value generated via Lucene's DateTools class.Returns the Locale for a string field that contains a locale-based value that contains language ("en") or language and country ("en_US").
+ *
+ * <p>
+ * A <code>toString()</code> on a english american locale returns the String <code>"en_US"</code>, but to create a locale
+ * from that string you can NOT just create it by doing: <code>new Locale("en_US")</code>. You must split language (en)
+ * and country (US) since the proper way of creating the Locale is: <code>new Locale("en", "US")</code>. Language must
+ * be lowercased and country must be uppercased. This method will handle that (i.e. <code>aLocaleFieldValue == "EN_us"</code>
+ * -&gt; <code>new Locale("en", "US")</code>).
+ * </p>
+ *
+ * <p>
+ * <strong>Note!</strong> This method does <em>NOT</em> handle variants!
+ * </p>Returns the Integer for a string field that contains a integer value generated via Lucene's NumberTools (i.e. long) class.Returns the Long for a string field that contains a long value generated via Lucene's NumberTools class.Returns the Double for a string field that contains a double value generated to be a sortable search value.
+ * @author Magnus Lövgren
+ * @see senselogic.sitevision.api.search.SearchHit#getBooleanField(String)
+ * @see senselogic.sitevision.api.search.SearchHit#getDateField(String)
+ * @see senselogic.sitevision.api.search.SearchHit#getFloatField(String)
+ * @see senselogic.sitevision.api.search.SearchHit#getLongField(String)
+ * @since Sitevision 2.6.2, 2.7_06
+ * @deprecated use the typed methods in {@link senselogic.sitevision.api.search.SearchHit} instead when extracting values from a search result.
+ */
+interface SearchFieldUtil {
+  /**
+   * Returns the Date for a string field that contains a date value generated via Lucene's DateTools class.
+   * @param aDateFieldValue the <code>String</code> that should be converted to a <code>Date</code>
+   * @return <code>aDateFieldValue</code> as <code>Date</code>, or <code>null</code> if indeterminable.
+   */
+  dateFieldToDate(aDateFieldValue: string): unknown;
+
+  /**
+   * Returns the Calendar for a string field that contains a date value generated via Lucene's DateTools class.
+   * @param aDateFieldValue the <code>String</code> that should be converted to a <code>Calendar</code>
+   * @return <code>aDateFieldValue</code> as <code>Calendar</code>, or <code>null</code> if indeterminable.
+   */
+  dateFieldToCalendar(aDateFieldValue: string): unknown;
+
+  /**
+   * Returns the Locale for a string field that contains a locale-based value that contains language ("en") or language and country ("en_US").
+   *
+   * <p>
+   * A <code>toString()</code> on a english american locale returns the String <code>"en_US"</code>, but to create a locale
+   * from that string you can NOT just create it by doing: <code>new Locale("en_US")</code>. You must split language (en)
+   * and country (US) since the proper way of creating the Locale is: <code>new Locale("en", "US")</code>. Language must
+   * be lowercased and country must be uppercased. This method will handle that (i.e. <code>aLocaleFieldValue == "EN_us"</code>
+   * -&gt; <code>new Locale("en", "US")</code>).
+   * </p>
+   *
+   * <p>
+   * <strong>Note!</strong> This method does <em>NOT</em> handle variants!
+   * </p>
+   * @param aLocaleFieldValue a String containing a language - or a language and country, separated with underscrore.
+   * @return a Locale matching <code>aLocaleFieldValue</code>, returns <code>null</code> if indeterminable (e.g <code>aLocaleFieldValue</code> is <code>null</code>)
+   * @deprecated use {@link senselogic.sitevision.api.i18n.LocaleUtil#getLocaleByString(String)} instead
+   */
+  localeFieldToLocale(aLocaleFieldValue: string): unknown;
+
+  /**
+   * Returns the Integer for a string field that contains a integer value generated via Lucene's NumberTools (i.e. long) class.
+   * @param anIntFieldValue the <code>String</code> that should be converted to a <code>Integer</code>
+   * @return <code>anIntFieldValue</code> as <code>Integer</code>, or <code>null</code> if indeterminable.
+   * @since Sitevision 2.6.2, 2.7.2
+   */
+  intFieldToInt(anIntFieldValue: string): number;
+
+  /**
+   * Returns the Long for a string field that contains a long value generated via Lucene's NumberTools class.
+   * @param aLongFieldValue the <code>String</code> that should be converted to a <code>Long</code>
+   * @return <code>aLongFieldValue</code> as <code>Long</code>, or <code>null</code> if indeterminable.
+   * @since Sitevision 2.6.2, 2.7.2
+   */
+  longFieldToLong(aLongFieldValue: string): number;
+
+  /**
+   * Returns the Double for a string field that contains a double value generated to be a sortable search value.
+   * @param aDoubleFieldValue the <code>String</code> that should be converted to a <code>Double</code>
+   * @return <code>aDoubleFieldValue</code> as <code>Double</code>, or <code>null</code> if indeterminable.
+   * @since Sitevision 2.6.2, 2.7.2
+   */
+  doubleFieldToDouble(aDoubleFieldValue: string): number;
+}
+
+export default SearchFieldUtil;

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

@@ -0,0 +1,45 @@
+import SearchHit from "../SearchHit";
+
+/**
+ * <p>
+ * This interface is deprecated and non-functional as of Sitevision 3.0. The Sitevision search engine has been replaced
+ * (from Lucene to Solr) and highlighting of arbitrary fields in a search result via <code>SearchHighlighter</code> is no longer possible.
+ * In Solr you should specify the field(-s) that should be highlighted when you execute the query.
+ * </p>Returns a highlighted fragment for the default highlighting field.Returns a highlighted fragment for a specified field.
+ * @author Magnus Lövgren
+ * @since Sitevision 2.7_06
+ * @deprecated This interface will do absolutely nothing as of Sitevision 3.0 (search engine has been replaced). Interface methods will not do anything (i.e. always return <code>null</code>) and this interface will be completely removed in future releases of Sitevision.
+ */
+interface SearchHighlighter {
+  /**
+   * Returns a highlighted fragment for the default highlighting field.
+   * @param aHighlightPreElement the opening element to the left of a highlighted word(-s), e.g <code>"&lt;strong style=\"background-color:yellow\"&gt;"</code>
+   * @param aHighlightPostElement the closing element to the right of a highlighted word(-s), e.g <code>"&lt;/strong&gt;"</code>
+   * @param aSearchHit the search hit that should be highlighted
+   * @return a highlighted text fragment with all matches surrounded with <code>aHighlightPreElement</code> and <code>aHighlightPostElement</code>, <code>null</code> if nothing could be highlighted
+   * @deprecated As of Sitevision 3.0 this method will always return <code>null</code>. Do <strong>not</strong> use this interface at all, it will be completely removed in future releases of Sitevision.
+   */
+  getHighlightedFragment(
+    aHighlightPreElement: string,
+    aHighlightPostElement: string,
+    aSearchHit: SearchHit
+  ): string;
+
+  /**
+   * Returns a highlighted fragment for a specified field.
+   * @param aHighlightPreElement the opening element to the left of a highlighted word(-s), e.g <code>"&lt;strong style=\"background-color:yellow\"&gt;"</code>
+   * @param aHighlightPostElement the closing element to the right of a highlighted word(-s), e.g <code>"&lt;/strong&gt;"</code>
+   * @param aSearchHit the search hit that should be highlighted
+   * @param aHighlightingFieldName the field that should be highlighted. A default field will be used if <code>aHighlightingFieldName</code> is <code>null</code>. The field that with most characters will be used if multiple fields match. Binary fields are ignored.
+   * @return a highlighted text fragment with all matches surrounded with <code>aHighlightPreElement</code> and <code>aHighlightPostElement</code>, <code>null</code> if nothing could be highlighted
+   * @deprecated As of Sitevision 3.0 this method will always return <code>null</code>. Do <strong>not</strong> use this interface at all, it will be completely removed in future releases of Sitevision.
+   */
+  getHighlightedFragment(
+    aHighlightPreElement: string,
+    aHighlightPostElement: string,
+    aSearchHit: SearchHit,
+    aHighlightingFieldName: string
+  ): string;
+}
+
+export default SearchHighlighter;