@searchcraft/react-sdk 0.9.5 → 0.9.7

package/dist/index.d.ts

@@ -46,6 +46,10 @@ export interface SearchcraftConfig {
 	 * The adm sub value.
 	 */
 	admSub?: string;
+	/**
+	 * The amount of debounce delay to add before calling the ad_container_rendered event
+	 */
+	adContainerRenderedDebounceDelay?: number;
 	/**
 	 * The number of custom ads to render at the start of the search results page.
 	 */
@@ -255,13 +259,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;
@@ -269,6 +274,14 @@ 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: {
@@ -403,6 +416,18 @@ declare class AdClient {
 	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;
@@ -470,6 +495,15 @@ declare class SearchcraftCore {
 		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
 	 */
@@ -1575,6 +1609,7 @@ declare namespace Components {
 	 */
 	interface SearchcraftAd {
 		"adClientResponseItem"?: AdClientResponseItem;
+		"adContainerId": string;
 		"adSource": SearchcraftAdSource;
 	}
 	/**
@@ -2490,6 +2525,7 @@ declare namespace LocalJSX {
 	 */
 	interface SearchcraftAd {
 		"adClientResponseItem"?: AdClientResponseItem;
+		"adContainerId"?: string;
 		"adSource"?: SearchcraftAdSource;
 	}
 	/**