@searchcraft/react-sdk 0.9.4 → 0.9.6

package/dist/index.d.ts

@@ -66,6 +66,34 @@ export interface SearchcraftConfig {
 	 * A callback function responsible for rendering the custom ad containers.
 	 */
 	customAdTemplate?: CustomAdTemplateRenderFunction;
+	/**
+	 * The placement id to use for Nativo ads.
+	 */
+	nativoPlacementId?: number;
+	/**
+	 * The class name for nativo ad containers.
+	 */
+	nativoAdClassName?: string;
+	/**
+	 * The number of custom ads to render at the start of the search results page.
+	 */
+	nativoAdStartQuantity?: number;
+	/**
+	 * The number of custom ads to render at the end of the search results page.
+	 */
+	nativoAdEndQuantity?: number;
+	/**
+	 * Renders a custom ad in between search results, at the specified interval.
+	 */
+	nativoAdInterstitialInterval?: number;
+	/**
+	 * Specify how many normal search results to render before rendering the first interstitial ad grouping.
+	 */
+	nativoAdInterstialStartIndex?: number;
+	/**
+	 * Specifies the number of ads to be rendered in each interstitial in between search results.
+	 */
+	nativoAdInterstitialQuantity?: number;
 }
 export type SearchcraftAdSource = "adMarketplace" | "Nativo" | "Custom" | "None";
 /**
@@ -227,12 +255,14 @@ export type SearchParams = {
 	rangeValueForIndexFields?: Record<string, RangeValueForIndexField>;
 };
 export interface SubscriptionEventMap {
-	ad_container_rendered: AdContainerSubscriptionEvent;
+	ad_container_rendered: AdContainerRenderedSubscriptionEvent;
+	ad_container_viewed: AdContainerViewedSubscriptionEvent;
+	query_fetched: QueryFetchedEvent;
 	query_submitted: QuerySubmittedEvent;
 	input_cleared: InputClearedEvent;
 	no_results_returned: NoResultsReturnedEvent;
 }
-export interface AdContainerSubscriptionEvent extends SubscriptionEvent {
+export interface AdContainerRenderedSubscriptionEvent extends SubscriptionEvent {
 	name: "ad_container_rendered";
 	data: {
 		adContainerId: string;
@@ -240,12 +270,26 @@ export interface AdContainerSubscriptionEvent extends SubscriptionEvent {
 		searchTerm: string;
 	};
 }
+export interface AdContainerViewedSubscriptionEvent extends SubscriptionEvent {
+	name: "ad_container_viewed";
+	data: {
+		adContainerId: string;
+		adSource: SearchcraftAdSource;
+		searchTerm: string;
+	};
+}
 export interface QuerySubmittedEvent extends SubscriptionEvent {
 	name: "query_submitted";
 	data: {
 		searchTerm: string;
 	};
 }
+export interface QueryFetchedEvent extends SubscriptionEvent {
+	name: "query_fetched";
+	data: {
+		searchTerm: string;
+	};
+}
 export interface InputClearedEvent extends SubscriptionEvent {
 	name: "input_cleared";
 }
@@ -365,6 +409,21 @@ declare class AdClient {
 	config: SearchcraftConfig;
 	constructor(config: SearchcraftConfig);
 	getAdsForSearchParams(_params: SearchParams): Promise<AdClientResponseItem[]>;
+	onQuerySubmitted(_params: SearchParams): Promise<void>;
+	onQueryFetched(_params: SearchParams, _response: SearchcraftResponse): Promise<void>;
+	onInputCleared(): Promise<void>;
+	onAdContainerRendered(_data: {
+		adClientResponseItem?: AdClientResponseItem;
+		adContainerId: string;
+		adSource: SearchcraftAdSource;
+		searchTerm: string;
+	}): Promise<void>;
+	onAdContainerViewed(_data: {
+		adClientResponseItem?: AdClientResponseItem;
+		adContainerId: string;
+		adSource: SearchcraftAdSource;
+		searchTerm: string;
+	}): Promise<void>;
 }
 declare class MeasureClient {
 	private measureRequestTimeout;
@@ -423,6 +482,28 @@ declare class SearchcraftCore {
 	private initClients;
 	emitEvent<T extends SubscriptionEventName>(eventName: T, event: SubscriptionEventMap[T]): void;
 	subscribe<T extends SubscriptionEventName>(eventName: T, callback: SubscriptionEventCallback<T>): UnsubscribeFunction;
+	/**
+	 * Called when a `<searchcraft-ad>` component is rendered
+	 */
+	handleAdContainerRendered(data: {
+		adClientResponseItem?: AdClientResponseItem;
+		adContainerId: string;
+		adSource: SearchcraftAdSource;
+		searchTerm: string;
+	}): void;
+	/**
+	 * Called when a `<searchcraft-ad>` is viewed
+	 */
+	handleAdContainerViewed(data: {
+		adClientResponseItem?: AdClientResponseItem;
+		adContainerId: string;
+		adSource: SearchcraftAdSource;
+		searchTerm: string;
+	}): void;
+	/**
+	 * Perform various actions when the input is cleared
+	 */
+	handleInputCleared(): void;
 	/**
 	 * Gets items from the SearchClient and the AdClient.
 	 */
@@ -1749,10 +1830,6 @@ declare namespace Components {
 		  * The input element's placeholder value.
 		 */
 		"placeholderValue": string;
-		/**
-		  * The starting value of the input element.
-		 */
-		"searchTerm": string;
 	}
 	/**
 	 * This web component serves as the input label for the searchcraft-input-form component.
@@ -2690,10 +2767,6 @@ declare namespace LocalJSX {
 		  * The input element's placeholder value.
 		 */
 		"placeholderValue"?: string;
-		/**
-		  * The starting value of the input element.
-		 */
-		"searchTerm"?: string;
 	}
 	/**
 	 * This web component serves as the input label for the searchcraft-input-form component.