@searchcraft/vue-sdk 0.10.4 → 0.10.6

package/dist/index.d.ts

@@ -277,21 +277,33 @@ export interface ADMAd {
 	sale_price?: number;
 	term: string;
 }
+export type Facet = {
+	/**
+	 * The path of the facet. The path represents where in the facet tree structure
+	 * this facet exists. There is an arbitrary number of levels in a facet tree.
+	 *
+	 * @example
+	 *
+	 * '/sports/college' - Represents that this is the facet node exists at [root] -> [sports] -> [college] in the facet tree.
+	 * '/weather' - Represents that this facet exists at [root] -> [weather] in the facet tree
+	 * '/news/local' - [root] -> [news] -> [local]
+	 */
+	path: string;
+	/**
+	 * The count value just represents an arbitrary `count` metadata for this facet node.
+	 */
+	count: number;
+};
+export type FacetWithChildrenArray = Facet & {
+	children: FacetWithChildrenArray[] | null | undefined;
+};
 /**
  * A Facet object returned in a search response.
  */
 export type FacetRoot = {
-	[key: string]: FacetChild[];
+	[key: string]: FacetWithChildrenArray[];
 };
 export type FacetPrime = FacetRoot[];
-/**
- * Represents the structure of facets, which group search results into categories.
- */
-export interface FacetChild {
-	count: number;
-	path: string;
-	children?: FacetChild[];
-}
 /**
  * Types of measure requests that can be sent to the /measure/event endpoint.
  */
@@ -530,6 +542,7 @@ declare class SearchClient {
 	private userId;
 	private parent;
 	private searchCompletedEventTimeout;
+	private abortController;
 	constructor(parent: SearchcraftCore, config: SearchcraftConfig, userId: string);
 	/**
 	 * Getter for the base url used by the /search endpoint.
@@ -538,9 +551,10 @@ declare class SearchClient {
 	/**
 	 * Make the request to get the search results.
 	 * @param {properties} properties - The properties for the search.
+	 * @param sendTelemetry - Whether or not to emit measure and subscription events for this search.
 	 * @returns
 	 */
-	getSearchResponseItems: (properties: SearchClientRequestProperties | string) => Promise<SearchcraftResponse>;
+	getSearchResponseItems: (properties: SearchClientRequestProperties | string, sendTelemetry?: boolean) => Promise<SearchcraftResponse>;
 	private handleGetSearchResponseItemsWithString;
 	private handleGetSearchResponseItemsWithObject;
 	/**
@@ -592,7 +606,7 @@ export declare class SearchcraftCore {
 	 * Perform various actions when the input is cleared
 	 */
 	handleInputCleared(): void;
-	getResponseItems: (properties: SearchClientRequestProperties | string, searchCallback: (response: SearchcraftResponse, items: SearchClientResponseItem[]) => void, adCallback: (items: AdClientResponseItem[]) => void) => void;
+	getResponseItems: (properties: SearchClientRequestProperties | string, searchCallback: (request: SearchClientRequestProperties | string, response: SearchcraftResponse, items: SearchClientResponseItem[], supplementalResponse: SearchcraftResponse | undefined) => void, adCallback: (items: AdClientResponseItem[]) => void) => void;
 }
 /**
  * Callable functions made available by the SearchcraftStore.
@@ -608,8 +622,8 @@ export interface SearchcraftStateFunctions {
 	search: () => Promise<void>;
 	set: (state: Partial<SearchcraftState> | ((state: SearchcraftState) => Partial<SearchcraftState>)) => SearchcraftState;
 	setAdClientResponseItems: (items: AdClientResponseItem[]) => void;
-	setSearchClientResponseItemsFromResponse: (response: SearchcraftResponse, items: SearchClientResponseItem[]) => void;
-	setInitialSearchClientResponseItemsFromResponse: (response: SearchcraftResponse, items: SearchClientResponseItem[]) => void;
+	setSearchClientResponseItemsFromResponse: (request: SearchClientRequestProperties | string, response: SearchcraftResponse, items: SearchClientResponseItem[], supplementalResponse: SearchcraftResponse | undefined) => void;
+	setInitialSearchClientResponseItemsFromResponse: (request: SearchClientRequestProperties | string, response: SearchcraftResponse, items: SearchClientResponseItem[]) => void;
 	setInitialQuery: (query: string) => void;
 	setPopoverVisibility: (isVisible: boolean) => void;
 	setSearchResultsCount: (count: number) => void;
@@ -640,9 +654,11 @@ export interface SearchcraftStateValues {
 	isSearchInProgress: boolean;
 	rangeValueForIndexFields: Record<string, RangeValueForIndexField>;
 	searchMode: "fuzzy" | "exact";
+	searchClientRequest: SearchClientRequestProperties | string | undefined | null;
 	searchClientResponseItems: SearchClientResponseItem[];
 	searchResponseTimeTaken: number | undefined;
 	searchResponseFacetPrime: FacetPrime | undefined | null;
+	supplementalFacetPrime: FacetPrime | undefined | null;
 	searchResultsCount: number;
 	searchResultsPage: number;
 	searchResultsPerPage: number;
@@ -802,6 +818,10 @@ export namespace Components {
 		  * The label rendered above the input.
 		 */
 		"inputLabel"?: string;
+		/**
+		  * The placeholder's render behavior. 'hide-on-focus' - Hide the placeholder text immediately when the input form gains focus. 'hide-on-text-entered' - Only hide the placeholder when the input form has text entered into it.
+		 */
+		"placeholderBehavior"?: "hide-on-focus" | "hide-on-text-entered";
 		/**
 		  * The input element's placeholder value.
 		 */
@@ -1148,13 +1168,13 @@ export namespace Components {
 	 */
 	interface SearchcraftSlider {
 		/**
-		  * The type of data allowed.
+		  * The type of data the sliders are using.
 		 */
 		"dataType": "number" | "date";
 		/**
-		  * The granularity that the value must adhere to.
+		  * The date granularity to use. Used to format date labels.
 		 */
-		"granularity": number;
+		"dateGranularity"?: "year" | "month" | "day" | "hour";
 		/**
 		  * The maximum value allowed.
 		 */
@@ -1163,6 +1183,10 @@ export namespace Components {
 		  * The minimum value allowed.
 		 */
 		"min": number;
+		/**
+		  * The step amount for the slider inputs.
+		 */
+		"step": number;
 	}
 	/**
 	 * This web component adds Searchcraft's built-in css theme to your page. It does not render anything visible, its only function is to manage the css styles on the page.'
@@ -1829,7 +1853,7 @@ declare namespace LocalJSX {
 		 */
 		"fieldName"?: string;
 		/**
-		  * When the facets are updated.
+		  * Emitted when the facets are updated.
 		 */
 		"onFacetSelectionUpdated"?: (event: SearchcraftFacetListCustomEvent<{
 			paths: string[];
@@ -1916,6 +1940,10 @@ declare namespace LocalJSX {
 		  * Event emitted when input initializes.
 		 */
 		"onInputInit"?: (event: SearchcraftInputFormCustomEvent<void>) => void;
+		/**
+		  * The placeholder's render behavior. 'hide-on-focus' - Hide the placeholder text immediately when the input form gains focus. 'hide-on-text-entered' - Only hide the placeholder when the input form has text entered into it.
+		 */
+		"placeholderBehavior"?: "hide-on-focus" | "hide-on-text-entered";
 		/**
 		  * The input element's placeholder value.
 		 */
@@ -2266,13 +2294,13 @@ declare namespace LocalJSX {
 	 */
 	interface SearchcraftSlider {
 		/**
-		  * The type of data allowed.
+		  * The type of data the sliders are using.
 		 */
 		"dataType"?: "number" | "date";
 		/**
-		  * The granularity that the value must adhere to.
+		  * The date granularity to use. Used to format date labels.
 		 */
-		"granularity"?: number;
+		"dateGranularity"?: "year" | "month" | "day" | "hour";
 		/**
 		  * The maximum value allowed.
 		 */
@@ -2285,6 +2313,10 @@ declare namespace LocalJSX {
 		  * When the range has changed.
 		 */
 		"onRangeChanged"?: (event: SearchcraftSliderCustomEvent<any>) => void;
+		/**
+		  * The step amount for the slider inputs.
+		 */
+		"step"?: number;
 	}
 	/**
 	 * This web component adds Searchcraft's built-in css theme to your page. It does not render anything visible, its only function is to manage the css styles on the page.'