@searchcraft/react-sdk 0.10.5 → 0.10.7

package/dist/server/index.d.ts

@@ -542,6 +542,8 @@ declare class SearchClient {
 	private userId;
 	private parent;
 	private searchCompletedEventTimeout;
+	private abortController;
+	private supplementalAbortController;
 	constructor(parent: SearchcraftCore, config: SearchcraftConfig, userId: string);
 	/**
 	 * Getter for the base url used by the /search endpoint.
@@ -550,10 +552,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.
+	 * @param isSupplemental - Whether or not this is a supplemental search request (for the purpose of getting top-level facet counts)
 	 * @returns
 	 */
-	getSearchResponseItems: (properties: SearchClientRequestProperties | string, sendTelemetry?: boolean) => Promise<SearchcraftResponse>;
+	getSearchResponseItems: (properties: SearchClientRequestProperties | string, isSupplemental?: boolean) => Promise<SearchcraftResponse>;
 	private handleGetSearchResponseItemsWithString;
 	private handleGetSearchResponseItemsWithObject;
 	/**
@@ -605,7 +607,7 @@ export declare class SearchcraftCore {
 	 * Perform various actions when the input is cleared
 	 */
 	handleInputCleared(): void;
-	getResponseItems: (properties: SearchClientRequestProperties | string, searchCallback: (response: SearchcraftResponse, items: SearchClientResponseItem[], supplementalResponse: SearchcraftResponse | undefined) => 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.
@@ -621,8 +623,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[], supplementalResponse: SearchcraftResponse | undefined) => 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;
@@ -653,6 +655,7 @@ 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;
@@ -679,8 +682,11 @@ export namespace Components {
 	 */
 	interface SearchcraftAd {
 		"adClientResponseItem"?: AdClientResponseItem;
-		"adContainerId": string;
 		"adSource": SearchcraftAdSource;
+		/**
+		  * Where the ad is being rendered within the search results div. Lifecycle behavior differs for ads being rendered in different positions, so we need to be able to handle all of those cases.
+		 */
+		"renderPosition": "interstitial" | "top" | "bottom";
 	}
 	/**
 	 * This web component represents a button.
@@ -1779,8 +1785,11 @@ declare namespace LocalJSX {
 	 */
 	interface SearchcraftAd {
 		"adClientResponseItem"?: AdClientResponseItem;
-		"adContainerId"?: string;
 		"adSource"?: SearchcraftAdSource;
+		/**
+		  * Where the ad is being rendered within the search results div. Lifecycle behavior differs for ads being rendered in different positions, so we need to be able to handle all of those cases.
+		 */
+		"renderPosition"?: "interstitial" | "top" | "bottom";
 	}
 	/**
 	 * This web component represents a button.