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

package/server/HighlightBuilder/index.d.ts

@@ -1,80 +1,6 @@
 import type { Highlight } from "../../types/senselogic/sitevision/api/search/searcher/component/Highlight";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
-/**
- * Adds a field that should be highlighted.
- *
- * <p>
- *    <em>Solr note: this is the 'hl.fl' param</em>
- * </p>
- * @param aHighlightedField name of the field, a <code>null</code> or whitespace-only value will be ignored
- * @return this builder
- */
-export function addHighlightedField(
-  aHighlightedField: string
-): HighlightBuilder;
-
-/**
- * Removes all previously added highlighted fields.
- * @return this builder
- */
-export function clearHighlightedFields(): HighlightBuilder;
-
-/**
- * Sets the number of chars that highlighted fragment should contain.
- *
- * <p>
- *    If no char count is specified, the default value of the index config will be used (200).
- * </p>
- *
- * <p>
- *    <em>Solr note: this is the 'hl.fragsize' param</em>
- * </p>
- * @param aCharCount the char count
- * @return this builder
- * @throws IllegalArgumentException if <code>aCharCount</code> is zero or negative
- */
-export function setFragmentCharCount(aCharCount: number): HighlightBuilder;
-
-/**
- * Sets the start value for the highlighted section(s) of a fragment.
- *
- * <p>
- *    If the pre string and post string are not specified, the default value of the index config will be used
- *    ('&lt;mark&gt;' and '&lt;/mark&gt;').
- * </p>
- *
- * <p>
- *    <em>Solr note: this is the 'hl.simple.pre' param</em>
- * </p>
- * @param aPreString a fragment start
- * @return this builder
- */
-export function setFragmentPreString(aPreString: string): HighlightBuilder;
-
-/**
- * Sets the end value for the highlighted section(s) of a fragment.
- *
- * <p>
- *    <strong>Note! </strong> The fragment <em>pre</em> value must match the fragment <em>post</em> string!
- *    E.g: if the <em>pre</em> string is "&lt;em&gt;", the <em>post</em> string would typically be "&lt;/em&gt;".
- * </p>
- *
- * <p>
- *    <em>Solr note: this is the 'hl.simple.post' param</em>
- * </p>
- * @param aPostString a fragment end
- * @return this builder
- */
-export function setFragmentPostString(aPostString: string): HighlightBuilder;
-
-/**
- * Creates a Highlight component instance using currently specified state/behaviour.
- * @return a Highlight component
- * @throws IllegalStateException if no highlighted field is specified, or if pre and post strings doesn't match (e.g. one of them is null)
- */
-export function build(): Highlight;
-
 /**
  * <p>
  *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.Highlight} component with specific behaviour.
@@ -151,15 +77,82 @@ export function build(): Highlight;
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace highlightBuilder {
-  export {
-    addHighlightedField,
-    clearHighlightedFields,
-    setFragmentCharCount,
-    setFragmentPreString,
-    setFragmentPostString,
-    build,
-  };
+export interface HighlightBuilder extends Builder {
+  /**
+   * Adds a field that should be highlighted.
+   *
+   * <p>
+   *    <em>Solr note: this is the 'hl.fl' param</em>
+   * </p>
+   * @param aHighlightedField name of the field, a <code>null</code> or whitespace-only value will be ignored
+   * @return this builder
+   */
+  addHighlightedField(aHighlightedField: string): HighlightBuilder;
+
+  /**
+   * Removes all previously added highlighted fields.
+   * @return this builder
+   */
+  clearHighlightedFields(): HighlightBuilder;
+
+  /**
+   * Sets the number of chars that highlighted fragment should contain.
+   *
+   * <p>
+   *    If no char count is specified, the default value of the index config will be used (200).
+   * </p>
+   *
+   * <p>
+   *    <em>Solr note: this is the 'hl.fragsize' param</em>
+   * </p>
+   * @param aCharCount the char count
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aCharCount</code> is zero or negative
+   */
+  setFragmentCharCount(aCharCount: number): HighlightBuilder;
+
+  /**
+   * Sets the start value for the highlighted section(s) of a fragment.
+   *
+   * <p>
+   *    If the pre string and post string are not specified, the default value of the index config will be used
+   *    ('&lt;mark&gt;' and '&lt;/mark&gt;').
+   * </p>
+   *
+   * <p>
+   *    <em>Solr note: this is the 'hl.simple.pre' param</em>
+   * </p>
+   * @param aPreString a fragment start
+   * @return this builder
+   */
+  setFragmentPreString(aPreString: string): HighlightBuilder;
+
+  /**
+   * Sets the end value for the highlighted section(s) of a fragment.
+   *
+   * <p>
+   *    <strong>Note! </strong> The fragment <em>pre</em> value must match the fragment <em>post</em> string!
+   *    E.g: if the <em>pre</em> string is "&lt;em&gt;", the <em>post</em> string would typically be "&lt;/em&gt;".
+   * </p>
+   *
+   * <p>
+   *    <em>Solr note: this is the 'hl.simple.post' param</em>
+   * </p>
+   * @param aPostString a fragment end
+   * @return this builder
+   */
+  setFragmentPostString(aPostString: string): HighlightBuilder;
+
+  /**
+   * Creates a Highlight component instance using currently specified state/behaviour.
+   * @return a Highlight component
+   * @throws IllegalStateException if no highlighted field is specified, or if pre and post strings doesn't match (e.g. one of them is null)
+   */
+  build(): Highlight;
 }
 
+declare namespace HighlightBuilder {}
+
+declare var highlightBuilder: HighlightBuilder;
+
 export default highlightBuilder;

package/server/IconUtil/index.d.ts

@@ -1,26 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * Gets the file icon node for a given file extension.
- * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
- * @return the file icon node for aFileExtension, or <code>null</code> if the extension has no icon mapping
- */
-export function getFileIcons(aFileExtension: string): Node;
-
-/**
- * Gets the small file icon URI for a given file extension
- * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
- * @return the small file icon URI for aFileExtension, or <code>null</code> if no small icon is specified for the extension
- */
-export function getSmallFileIconURI(aFileExtension: string): string;
-
-/**
- * Gets the large file icon URI for a given file extension
- * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
- * @return the large file icon URI for aFileExtension, or <code>null</code> if no large icon is specified for the extension
- */
-export function getLargeFileIconURI(aFileExtension: string): string;
-
 /**
  * Utility interface for Icons.
  *
@@ -30,8 +9,31 @@ export function getLargeFileIconURI(aFileExtension: string): string;
  * </p>
  * @author Magnus Lövgren
  */
-declare namespace iconUtil {
-  export { getFileIcons, getSmallFileIconURI, getLargeFileIconURI };
+export interface IconUtil {
+  /**
+   * Gets the file icon node for a given file extension.
+   * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
+   * @return the file icon node for aFileExtension, or <code>null</code> if the extension has no icon mapping
+   */
+  getFileIcons(aFileExtension: string): Node;
+
+  /**
+   * Gets the small file icon URI for a given file extension
+   * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
+   * @return the small file icon URI for aFileExtension, or <code>null</code> if no small icon is specified for the extension
+   */
+  getSmallFileIconURI(aFileExtension: string): string;
+
+  /**
+   * Gets the large file icon URI for a given file extension
+   * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
+   * @return the large file icon URI for aFileExtension, or <code>null</code> if no large icon is specified for the extension
+   */
+  getLargeFileIconURI(aFileExtension: string): string;
 }
 
+declare namespace IconUtil {}
+
+declare var iconUtil: IconUtil;
+
 export default iconUtil;

package/server/ImageLinkRenderer/index.d.ts

@@ -1,34 +1,5 @@
-import LinkRenderer from "../LinkRenderer";
-import ImageRenderer from "../ImageRenderer";
-
-/**
- * Returns the LinkRenderer instance used by this image link renderer to control linking behaviour.
- * @return the LinkRenderer instance used by this image link renderer
- * @see LinkRenderer
- */
-export function getLinkRenderer(): LinkRenderer;
-
-/**
- * Returns the ImageRenderer instance used by this image link renderer to control (linked) image behaviour.
- *
- * <p>
- * <em>Note!</em> The <code>useAutoDescription</code> is initially set to <code>true</code> when the ImageRenderer instance is
- * created by this image link renderer, see <a href="#descnote">validation note above</a>.
- * </p>
- * @return the ImageRenderer instance used by this image link renderer
- * @see ImageRenderer
- */
-export function getImageRenderer(): ImageRenderer;
-
-/**
- * Builds a html link based on current state of the link renderer and the image render.
- *
- * <p>
- * <em>Note!</em> The render method is not thread safe, see <a href="#threadnote">thread note above</a>.
- * </p>
- * @return a html link, ready to print out on a page
- */
-export function render(): string;
+import type { LinkRenderer } from "../LinkRenderer";
+import type { ImageRenderer } from "../ImageRenderer";
 
 /**
  * ImageLinkRenderer is a stateful utility interface that combines an ImageRenderer and a LinkRenderer to render valid image links.
@@ -118,8 +89,39 @@ export function render(): string;
  * @see LinkRenderer
  * @see ImageRenderer
  */
-declare namespace imageLinkRenderer {
-  export { getLinkRenderer, getImageRenderer, render };
+export interface ImageLinkRenderer {
+  /**
+   * Returns the LinkRenderer instance used by this image link renderer to control linking behaviour.
+   * @return the LinkRenderer instance used by this image link renderer
+   * @see LinkRenderer
+   */
+  getLinkRenderer(): LinkRenderer;
+
+  /**
+   * Returns the ImageRenderer instance used by this image link renderer to control (linked) image behaviour.
+   *
+   * <p>
+   * <em>Note!</em> The <code>useAutoDescription</code> is initially set to <code>true</code> when the ImageRenderer instance is
+   * created by this image link renderer, see <a href="#descnote">validation note above</a>.
+   * </p>
+   * @return the ImageRenderer instance used by this image link renderer
+   * @see ImageRenderer
+   */
+  getImageRenderer(): ImageRenderer;
+
+  /**
+   * Builds a html link based on current state of the link renderer and the image render.
+   *
+   * <p>
+   * <em>Note!</em> The render method is not thread safe, see <a href="#threadnote">thread note above</a>.
+   * </p>
+   * @return a html link, ready to print out on a page
+   */
+  render(): string;
 }
 
+declare namespace ImageLinkRenderer {}
+
+declare var imageLinkRenderer: ImageLinkRenderer;
+
 export default imageLinkRenderer;