@searchcraft/javascript-sdk 0.10.6 → 0.11.0

package/dist/components/index.d.ts

@@ -1,27 +1,119 @@
 // Generated by dts-bundle-generator v9.5.1
 
 import { HTMLStencilElement, JSXBase } from '@stencil/core/internal';
+import { StoreApi } from 'zustand';
 
-declare enum LogLevel {
-	DEBUG = 0,
-	INFO = 1,
-	WARN = 2,
-	ERROR = 3
+export interface ADMResponse {
+	partial_qt: string;
+	text_ads: ADMAd[];
+	product_ads: ADMAd[];
 }
-export interface SDKDebuggerOptions {
-	logLevel: LogLevel;
-	logFormatter?: (level: LogLevel, message: string) => string;
+export interface AdClientResponseItem {
+	id: string;
+}
+export interface ADMClientResponseItem extends AdClientResponseItem {
+	admAdType: "adm-text-ad" | "adm-product-ad";
+	admAd?: ADMAd;
+}
+export interface ADMAd {
+	adv_id: number;
+	adv_name: string;
+	click_url?: string;
+	image_url?: string;
+	impression_url?: string;
+	price?: number;
+	price_currency?: string;
+	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;
+};
+export type FacetWithChildrenObject = Facet & {
+	children: Record<string, FacetWithChildrenObject>;
+};
+/**
+ * A Facet object returned in a search response.
+ */
+export type FacetRoot = {
+	[key: string]: FacetWithChildrenArray[];
+};
+export type FacetPrime = FacetRoot[];
+/**
+ * A structured Facet tree.
+ *
+ * A Facet tree is the root node of a "complete view" of the facet node tree.
+ * Nodes are structured based on the `path` of each facet
+ *
+ */
+export type FacetTree = FacetWithChildrenObject;
+/**
+ * Types of measure requests that can be sent to the /measure/event endpoint.
+ */
+export type MeasureEventName = "sdk_initialized" | "search_requested" | "search_response_received" | "search_completed" | "document_clicked";
+/**
+ * The type used for sending multiple measure events in a single network request.
+ * Uses /measure/batch request.
+ */
+export interface BatchMeasureRequest {
+	items: MeasureRequest[];
 }
-declare class Logger {
-	private logLevel;
-	private logFormatter;
-	constructor(options: SDKDebuggerOptions);
-	private defaultFormatter;
-	debug(message: string): void;
-	info(message: string): void;
-	warn(message: string): void;
-	error(message: string): void;
-	log(level: LogLevel, message: string): void;
+/**
+ * The type representing a measure request.
+ */
+export interface MeasureRequest {
+	event_name: MeasureEventName;
+	properties: MeasureRequestProperties;
+	user: MeasureRequestUser;
+}
+/**
+ * Properties attached to a measure request.
+ */
+export interface MeasureRequestProperties {
+	searchcraft_organization_id?: string;
+	searchcraft_application_id?: string;
+	searchcraft_index_names: string[];
+	search_term?: string;
+	number_of_documents?: number;
+	external_document_id?: string;
+	document_position?: number;
+	session_id?: string;
+}
+/**
+ * User properties attached to a measure request.
+ */
+export interface MeasureRequestUser {
+	user_id: string;
+	country?: string;
+	city?: string;
+	device_id?: string;
+	client_ip?: string;
+	locale?: string;
+	os?: string;
+	platform?: string;
+	region?: string;
+	sdk_name?: string;
+	sdk_version?: string;
+	user_agent?: string;
+	latitude?: number;
+	longitude?: number;
 }
 /**
  * A data type representing an index field value, along with properties
@@ -106,7 +198,7 @@ export interface DateRangeFilterItem extends FilterItem {
 	type: "dateRange";
 	options: {
 		minDate: Date;
-		maxDate: Date;
+		maxDate?: Date;
 		granularity: "year" | "month" | "day" | "hour";
 	};
 }
@@ -153,192 +245,142 @@ export type PopoverButtonTemplate = (data: {
 export type ADMAdTemplate = (data: ADMAd, utils: {
 	html: TemplateHtml;
 }) => string;
-/**
- * The SearchcraftConfig object is used to initialize Searchcraft in your application.
- */
-export interface SearchcraftConfig {
+export interface CustomAdConfig {
 	/**
-	 * Host IP Address and port number configured and created using Vektron.
+	 * The amount of debounce delay to add before calling the ad_container_rendered event
 	 */
-	endpointURL: string;
+	adContainerRenderedDebounceDelay?: number;
 	/**
-	 * Name or names of search indices configured using Vektron. Given as an array of strings.
+	 * The number of custom ads to render at the start of the search results page.
 	 */
-	index: string[];
+	adStartQuantity?: number;
 	/**
-	 * A unique user identifier for the end user.
+	 * The number of custom ads to render at the end of the search results page.
 	 */
-	userId?: string;
+	adEndQuantity?: number;
 	/**
-	 * The Index read key provided by Vektron.
+	 * Renders a custom ad in between search results, at the specified interval.
 	 */
-	readKey: string;
+	adInterstitialInterval?: number;
 	/**
-	 * The amount of delay, in milliseconds, to debounce search requests. Defaults to `0`.
+	 * Specifies the number of ads to be rendered in each interstitial in between search results.
 	 */
-	searchDebounceDelay?: number;
+	adInterstitialQuantity?: number;
 	/**
-	 * The maximum number of results to return per page.
+	 * A callback function responsible for rendering the custom ad containers.
 	 */
-	searchResultsPerPage?: number;
+	template: CustomAdTemplate;
+}
+export interface NativoAdConfig {
 	/**
-	 * Name of the ad source to use.
+	 * The placement id to use for Nativo ads.
 	 */
-	adSource?: "adMarketplace" | "Nativo" | "Custom" | "None";
+	placementId?: number;
 	/**
-	 * The maximum number of product ads to show for a single search term.
+	 * The class name for nativo ad containers.
 	 */
-	admProductAdQuantity?: number;
+	adClassName?: string;
 	/**
-	 * The maximum number of text ads to show for a single search term.
+	 * The number of custom ads to render at the start of the search results page.
 	 */
-	admTextAdQuantity?: number;
+	adStartQuantity?: number;
 	/**
-	 * The adm sub value.
+	 * The number of custom ads to render at the end of the search results page.
 	 */
-	admSub?: string;
+	adEndQuantity?: number;
 	/**
-	 * The amount of debounce delay to add before calling the ad_container_rendered event
+	 * Renders a custom ad in between search results, at the specified interval.
 	 */
-	adContainerRenderedDebounceDelay?: number;
+	adInterstitialInterval?: number;
 	/**
-	 * A callback function responsible for rendering the ADM ad containers.
+	 * Specify how many normal search results to render before rendering the first interstitial ad grouping.
 	 */
-	admAdTemplate?: ADMAdTemplate;
+	adInterstialStartIndex?: number;
 	/**
-	 * The number of custom ads to render at the start of the search results page.
+	 * Specifies the number of ads to be rendered in each interstitial in between search results.
 	 */
-	customAdStartQuantity?: number;
+	adInterstitialQuantity?: number;
+}
+export interface ADMAdConfig {
 	/**
-	 * The number of custom ads to render at the end of the search results page.
+	 * The number of product ads to request.
 	 */
-	customAdEndQuantity?: number;
+	productAdQuantity?: number;
 	/**
-	 * Renders a custom ad in between search results, at the specified interval.
+	 * The number of text ads to request.
 	 */
-	customAdInterstitialInterval?: number;
+	textAdQuantity?: number;
 	/**
-	 * Specifies the number of ads to be rendered in each interstitial in between search results.
+	 * The adm sub value.
 	 */
-	customAdInterstitialQuantity?: number;
+	sub?: string;
 	/**
-	 * A callback function responsible for rendering the custom ad containers.
+	 * A callback function responsible for rendering the ADM ad containers.
 	 */
-	customAdTemplate?: CustomAdTemplate;
+	template?: ADMAdTemplate;
+}
+/**
+ * The SearchcraftConfig object is used to initialize the Searchcraft JavaScript SDK in your front-end application. See the [getting started page](https://docs.searchcraft.io/sdks/javascript/getting-started/) for a guide on how and where to use this configuration object.
+ */
+export interface SearchcraftConfig {
 	/**
-	 * The placement id to use for Nativo ads.
+	 * The read key value to use when sending Searchcraft search requests. This value needs read key-specific permissions. If you are using Searchcraft Cloud, this value can be configured in Vektron.
 	 */
-	nativoPlacementId?: number;
+	readKey: string;
 	/**
-	 * The class name for nativo ad containers.
+	 * The endpoint url of your Searchcraft cluster where your specified search index exists. If you are using Searchcraft Cloud, this value can be found within the Vektron dashboard in the Code Snippets section when configuring a search index.
 	 */
-	nativoAdClassName?: string;
+	endpointURL: string;
 	/**
-	 * The number of custom ads to render at the start of the search results page.
+	 * Name of the Searchcraft search index to search for results within. If you are using Searchcraft Cloud, this value can be found within the Vektron dashboard in the Code Snippets section when configuring a search index.
 	 */
-	nativoAdStartQuantity?: number;
+	indexName: string;
 	/**
-	 * The number of custom ads to render at the end of the search results page.
+	 * The initial search query to call when Searchcraft is first initialized in your front-end application. This parameter can be used when you want to populate a page with an initial set of search results based on a query.
+	 *
+	 * This value is a stringified Search query object. For a more in-depth reference on search queries, see the [search endpoint documentation](https://docs.searchcraft.io/api/search/).
 	 */
-	nativoAdEndQuantity?: number;
+	initialQuery?: string;
 	/**
-	 * Renders a custom ad in between search results, at the specified interval.
+	 * The maximum number of documents to return per page of results.
 	 */
-	nativoAdInterstitialInterval?: number;
+	searchResultsPerPage?: number;
 	/**
-	 * Specify how many normal search results to render before rendering the first interstitial ad grouping.
+	 * The URL pointing towards Searchcraft Cloud's semantic search and RAG summary processing layer. When using a `searchcraft-summary-box` component, this value must be specified.
 	 */
-	nativoAdInterstialStartIndex?: number;
+	cortexURL?: string;
 	/**
-	 * Specifies the number of ads to be rendered in each interstitial in between search results.
+	 * Instructions provided to the LLM when creating search result summaries.
 	 */
-	nativoAdInterstitialQuantity?: number;
-}
-export type SearchcraftAdSource = "adMarketplace" | "Nativo" | "Custom" | "None";
-/**
- * Used internally by consuming packages as part of the core sdk constructor.
- */
-export interface SearchcraftSDKInfo {
-	sdkName: string;
-	sdkVersion: string;
-}
-export interface AdClientResponseItem {
-	id: string;
-	adSource: SearchcraftAdSource;
-}
-export interface ADMAd {
-	adv_id: number;
-	adv_name: string;
-	click_url?: string;
-	image_url?: string;
-	impression_url?: string;
-	price?: number;
-	price_currency?: string;
-	sale_price?: number;
-	term: string;
-}
-export type Facet = {
+	summaryInstructionsPrompt?: string;
 	/**
-	 * 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]
+	 * The amount of delay, in milliseconds, to debounce summary requests. Defaults to `1000`
 	 */
-	path: string;
+	summaryDebounceDelay?: number;
 	/**
-	 * The count value just represents an arbitrary `count` metadata for this facet node.
+	 * Name of the ad source to use.
 	 */
-	count: number;
-};
-export type FacetWithChildrenArray = Facet & {
-	children: FacetWithChildrenArray[] | null | undefined;
-};
-/**
- * A Facet object returned in a search response.
- */
-export type FacetRoot = {
-	[key: string]: FacetWithChildrenArray[];
-};
-export type FacetPrime = FacetRoot[];
-/**
- * Types of measure requests that can be sent to the /measure/event endpoint.
- */
-export type MeasureEventName = "sdk_initialized" | "search_requested" | "search_response_received" | "search_completed" | "document_clicked";
-/**
- * Properties attached to a measure request.
- */
-export interface MeasureRequestProperties {
-	searchcraft_organization_id?: string;
-	searchcraft_application_id?: string;
-	searchcraft_index_names: string[];
-	search_term?: string;
-	number_of_documents?: number;
-	external_document_id?: string;
-	document_position?: number;
-	session_id?: string;
+	searchDebounceDelay?: number;
+	/**
+	 * A unique user identifier for end users of your product. This would typically correspond to a user id
+	 * in your consuming application's database. Used for data analysis and visualizations on Vektron.
+	 */
+	measureUserIdentifier?: string;
+	/**
+	 * This object allows you to configure the quantity, number, template, and positioning of custom ad containers within your search results.
+	 *
+	 * To see more information on how to configure custom ads, see [the custom ads guide](https://docs.searchcraft.io/sdks/javascript/custom-ads/)
+	 */
+	customAdConfig?: CustomAdConfig;
+	nativoConfig?: NativoAdConfig;
+	admAdConfig?: ADMAdConfig;
 }
 /**
- * User properties attached to a measure request.
+ * Used internally by consuming packages as part of the core sdk constructor.
  */
-export interface MeasureRequestUser {
-	user_id: string;
-	country?: string;
-	city?: string;
-	device_id?: string;
-	client_ip?: string;
-	locale?: string;
-	os?: string;
-	platform?: string;
-	region?: string;
-	sdk_name?: string;
-	sdk_version?: string;
-	user_agent?: string;
-	latitude?: number;
-	longitude?: number;
+export interface SearchcraftSDKInfo {
+	sdkName: string;
+	sdkVersion: string;
 }
 export interface FacetPathsForIndexField {
 	fieldName: string;
@@ -348,6 +390,22 @@ export interface RangeValueForIndexField {
 	fieldName: string;
 	value: string;
 }
+export interface SearchClientQuery {
+	occur?: "must" | "should";
+	exact?: {
+		ctx: string;
+	};
+	fuzzy?: {
+		ctx: string;
+	};
+}
+export type SearchClientRequest = {
+	limit?: number;
+	offset?: number;
+	order_by?: string;
+	sort?: "asc" | "desc";
+	query: SearchClientQuery[];
+};
 export interface SearchClientRequestProperties {
 	/**
 	 * The search mode, which can be either 'fuzzy' or 'exact'.
@@ -453,7 +511,6 @@ export interface AdContainerRenderedSubscriptionEvent extends SubscriptionEvent
 	name: "ad_container_rendered";
 	data: {
 		adContainerId: string;
-		adSource: SearchcraftAdSource;
 		searchTerm: string;
 	};
 }
@@ -461,7 +518,6 @@ export interface AdContainerViewedSubscriptionEvent extends SubscriptionEvent {
 	name: "ad_container_viewed";
 	data: {
 		adContainerId: string;
-		adSource: SearchcraftAdSource;
 		searchTerm: string;
 	};
 }
@@ -502,13 +558,11 @@ declare class AdClient {
 	onAdContainerRendered(_data: {
 		adClientResponseItem?: AdClientResponseItem;
 		adContainerId: string;
-		adSource: SearchcraftAdSource;
 		searchTerm: string;
 	}): Promise<void>;
 	onAdContainerViewed(_data: {
 		adClientResponseItem?: AdClientResponseItem;
 		adContainerId: string;
-		adSource: SearchcraftAdSource;
 		searchTerm: string;
 	}): Promise<void>;
 }
@@ -543,18 +597,23 @@ declare class SearchClient {
 	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.
 	 */
 	private get baseSearchUrl();
+	/**
+	 * Immediately cancels all pending search requests.
+	 */
+	abortRequests: () => void;
 	/**
 	 * 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;
 	/**
@@ -564,49 +623,13 @@ declare class SearchClient {
 	 */
 	private formatParamsForRequest;
 }
-/**
- * Javascript Class providing the functionality to interact with the Searchcraft BE
- */
-export declare class SearchcraftCore {
-	config: SearchcraftConfig;
-	measureClient: MeasureClient | undefined;
-	searchClient: SearchClient | undefined;
-	adClient: AdClient | undefined;
-	userId: string;
-	private requestTimeout;
-	private subscriptionEvents;
-	constructor(config: SearchcraftConfig, sdkInfo: SearchcraftSDKInfo);
-	private initInputForms;
-	/**
-	 * When changes happen in the DOM, we want to link any input forms found to the instance of the core.
-	 */
-	private startObservingMutations;
-	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;
-	getResponseItems: (properties: SearchClientRequestProperties | string, searchCallback: (request: SearchClientRequestProperties | string, response: SearchcraftResponse, items: SearchClientResponseItem[], supplementalResponse: SearchcraftResponse | undefined) => void, adCallback: (items: AdClientResponseItem[]) => void) => void;
+declare class SummaryClient {
+	private set;
+	private get;
+	private abortController;
+	private timeout;
+	constructor(get: SearchcraftStore["getState"], set: SearchcraftStore["setState"]);
+	streamSummaryData(): void;
 }
 /**
  * Callable functions made available by the SearchcraftStore.
@@ -614,20 +637,12 @@ export declare class SearchcraftCore {
 export interface SearchcraftStateFunctions {
 	addFacetPathsForIndexField: (field: FacetPathsForIndexField) => void;
 	addRangeValueForIndexField: (field: RangeValueForIndexField) => void;
-	getSearchcraftCore: () => SearchcraftCore | undefined;
-	init: (searchcraft: SearchcraftCore | undefined, debug?: boolean) => void;
 	removeFacetPathsForIndexField: (fieldName: string) => void;
 	removeRangeValueForIndexField: (fieldName: string) => void;
-	resetFacetPaths: () => void;
+	resetSearchValues: () => void;
 	search: () => Promise<void>;
-	set: (state: Partial<SearchcraftState> | ((state: SearchcraftState) => Partial<SearchcraftState>)) => SearchcraftState;
-	setAdClientResponseItems: (items: AdClientResponseItem[]) => 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;
-	setSearchClientResponseItems: (items: SearchClientResponseItem[]) => void;
 	setSearchResultsPage: (page: number) => void;
 	setSearchResultsPerPage: (perPage: number) => void;
 	setSearchTerm: (searchTerm: string) => void;
@@ -643,19 +658,19 @@ export interface SearchcraftStateFunctions {
  */
 export interface SearchcraftStateValues {
 	adClientResponseItems: AdClientResponseItem[];
+	cachedAdClientResponseItems: AdClientResponseItem[];
 	core: SearchcraftCore | undefined;
 	hotkey: string;
 	hotkeyModifier: "ctrl" | "meta" | "alt" | "option";
-	logger: Logger | undefined;
 	facetPathsForIndexFields: Record<string, FacetPathsForIndexField>;
-	initialQuery: string;
-	initialSearchClientResponseItems: SearchClientResponseItem[];
 	isPopoverVisible: boolean;
 	isSearchInProgress: boolean;
 	rangeValueForIndexFields: Record<string, RangeValueForIndexField>;
 	searchMode: "fuzzy" | "exact";
-	searchClientRequest: SearchClientRequestProperties | string | undefined | null;
+	searchClientRequest?: SearchClientRequest;
+	searchClientRequestProperties: SearchClientRequestProperties | string | undefined | null;
 	searchClientResponseItems: SearchClientResponseItem[];
+	cachedSearchClientResponseItems: SearchClientResponseItem[];
 	searchResponseTimeTaken: number | undefined;
 	searchResponseFacetPrime: FacetPrime | undefined | null;
 	supplementalFacetPrime: FacetPrime | undefined | null;
@@ -665,11 +680,60 @@ export interface SearchcraftStateValues {
 	searchTerm: string;
 	orderByField: string | undefined | null;
 	sortType: "asc" | "desc" | undefined | null;
-	afterInit: (state: SearchcraftState) => void;
+	summary: string;
+	hasSummaryBox: boolean;
+	isSummaryLoading: boolean;
+	summaryClient?: SummaryClient;
 }
 export interface SearchcraftState extends SearchcraftStateFunctions, SearchcraftStateValues {
 }
-export declare const searchcraftStore: import("zustand").StoreApi<SearchcraftState>;
+export type SearchcraftStore = StoreApi<SearchcraftState>;
+/**
+ * Javascript Class providing the functionality to interact with the Searchcraft BE
+ */
+export declare class SearchcraftCore {
+	store: SearchcraftStore;
+	config: SearchcraftConfig;
+	measureClient: MeasureClient | undefined;
+	searchClient: SearchClient | undefined;
+	adClient: AdClient | undefined;
+	userId: string;
+	private requestTimeout;
+	private subscriptionEvents;
+	/**
+	 * @param config The SearchcraftConfig object for this Searchcraft instance.
+	 * @param sdkInfo The SDK info object for this searchcraft instance
+	 * @param searchcraftId The identifier to use to reference this instance of SearchcraftCore.
+	 */
+	constructor(config: SearchcraftConfig, sdkInfo: SearchcraftSDKInfo, searchcraftId: string | undefined);
+	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;
+		searchTerm: string;
+	}): void;
+	/**
+	 * Called when a `<searchcraft-ad>` is viewed
+	 */
+	handleAdContainerViewed(data: {
+		adClientResponseItem?: AdClientResponseItem;
+		adContainerId: string;
+		searchTerm: string;
+	}): void;
+	/**
+	 * Perform various actions when the input is cleared
+	 */
+	handleInputCleared(): void;
+	getResponseItems: (props: {
+		requestProperties: SearchClientRequestProperties | string;
+		shouldCacheResultsForEmptyState: boolean;
+	}) => void;
+}
 export type SearchcraftSelectOption = {
 	label: string;
 	value: string | number;
@@ -681,8 +745,15 @@ export namespace Components {
 	 */
 	interface SearchcraftAd {
 		"adClientResponseItem"?: AdClientResponseItem;
-		"adContainerId": string;
-		"adSource": SearchcraftAdSource;
+		"adSource": "Custom" | "Nativo" | "adMarketplace";
+		/**
+		  * 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";
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component represents a button.
@@ -748,6 +819,10 @@ export namespace Components {
 		  * The name of the field where facets are applied.
 		 */
 		"fieldName": string;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component represents a series of filters that allows users to refine and control their search queries by applying various filter criteria.
@@ -780,6 +855,10 @@ export namespace Components {
 		  * The items to filter.
 		 */
 		"items": FilterItem[];
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component provides a user-friendly interface for querying an indexed dataset, enabling users to easily search large collections of data.
@@ -813,7 +892,6 @@ export namespace Components {
 		  * Where to place the search button.
 		 */
 		"buttonPlacement"?: "left" | "right" | "none";
-		"core"?: SearchcraftCore;
 		/**
 		  * The label rendered above the input.
 		 */
@@ -826,6 +904,10 @@ export namespace Components {
 		  * The input element's placeholder value.
 		 */
 		"placeholderValue"?: string;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component serves as the input label for the searchcraft-input-form component.
@@ -840,6 +922,12 @@ export namespace Components {
 		"inputLabelClassName"?: string | undefined;
 		"label": string;
 	}
+	/**
+	 * Renders a loading spinner/loading state for use in things like the summary box.
+	 */
+	interface SearchcraftLoading {
+		"label"?: string;
+	}
 	/**
 	 * This web component is designed to facilitate pagination of search results. Once a query is submitted, calculates the number for pages.
 	 * @react-import ```jsx
@@ -859,6 +947,10 @@ export namespace Components {
 	 * ```
 	 */
 	interface SearchcraftPagination {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * Renders a button which, when clicked, turns on popover visibility.
@@ -901,6 +993,10 @@ export namespace Components {
 	 * ```
 	 */
 	interface SearchcraftPopoverButton {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * A callback function responsible for rendering the button contents.
 		 */
@@ -914,6 +1010,10 @@ export namespace Components {
 	 * Renders the footer for the searchcraft-popover-form.
 	 */
 	interface SearchcraftPopoverFooter {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component is designed to display search results in a popover container that dynamically appears when the user interacts with a search input field, or when a popover-button is pressed.
@@ -952,6 +1052,10 @@ export namespace Components {
 		  * Formats the content rendered for each result.
 		 */
 		"popoverResultMappings"?: PopoverResultMappings;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * The type of popover form to render. - `inline` - Renders inline with the rest of the content on the page. The search results pop over the page content. - `fullscreen` - Renders in fullscreen view. Used together with the `searchcraft-popover-button` component. - `modal` - Renders in a modal view. Used together with the `searchcraft-popover-button` component.
 		 */
@@ -967,6 +1071,10 @@ export namespace Components {
 		"documentPosition": number;
 		"item": SearchClientResponseItem | undefined;
 		"popoverResultMappings": PopoverResultMappings | undefined;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component is designed to display a list of results within a popover interface.
@@ -987,6 +1095,10 @@ export namespace Components {
 		"searchClientResponseItems": SearchClientResponseItem[] | undefined;
 		"searchResultsPage": number;
 		"searchResultsPerPage": number;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component is designed to display the number of results returned from a search query.
@@ -1023,6 +1135,10 @@ export namespace Components {
 	 * ```
 	 */
 	interface SearchcraftResultsInfo {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * A callback function responsible for rendering the results info.
 		 */
@@ -1041,6 +1157,10 @@ export namespace Components {
 		 */
 		"index": number;
 		"item"?: SearchClientResponseItem;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * A callback function responsible for rendering a result.
 		 */
@@ -1092,6 +1212,10 @@ export namespace Components {
 		  * A query that will appears when the component initializes or the search term is ''..
 		 */
 		"initialQuery"?: string;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * A callback function responsible for rendering a result. Passed to `searchcraft-search-result`.
 		 */
@@ -1121,6 +1245,10 @@ export namespace Components {
 		  * The amount the options will increase (e.g. 20 = [20, 40, 60, 80, 100]). The base value is defined by the `searchResultsPerPage` option in the configuration.
 		 */
 		"increment": string | number;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component is designed to allow users to select between a group of options.
@@ -1188,6 +1316,33 @@ export namespace Components {
 		 */
 		"step": number;
 	}
+	/**
+	 * This component renders a summary box for RAG search result summaries.
+	 * When the user makes a search, a network call is made to retrieve the summary content, which is then
+	 * rendered in this box.
+	 * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+	 * @react-import ```jsx
+	 * import { SearchcraftSummaryBox } from "@searchcraft/react-sdk";
+	 * ```
+	 * @vue-import ```jsx
+	 * import { SearchcraftSummaryBox } from "@searchcraft/vue-sdk";
+	 * ```
+	 * @js-example ```html
+	 * <searchcraft-summary-box />
+	 * ```
+	 * @react-example ```jsx
+	 * <SearchcraftSummaryBox />
+	 * ```
+	 * @vue-example ```jsx
+	 * <SearchcraftSummaryBox />
+	 * ```
+	 */
+	interface SearchcraftSummaryBox {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
+	}
 	/**
 	 * 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.'
 	 * @react-import ```jsx
@@ -1216,6 +1371,10 @@ export namespace Components {
 		  * The label.
 		 */
 		"label": string;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * The secondary label displayed below the main label.
 		 */
@@ -1407,6 +1566,15 @@ declare global {
 		prototype: HTMLSearchcraftInputLabelElement;
 		new (): HTMLSearchcraftInputLabelElement;
 	};
+	/**
+	 * Renders a loading spinner/loading state for use in things like the summary box.
+	 */
+	interface HTMLSearchcraftLoadingElement extends Components.SearchcraftLoading, HTMLStencilElement {
+	}
+	var HTMLSearchcraftLoadingElement: {
+		prototype: HTMLSearchcraftLoadingElement;
+		new (): HTMLSearchcraftLoadingElement;
+	};
 	/**
 	 * This web component is designed to facilitate pagination of search results. Once a query is submitted, calculates the number for pages.
 	 * @react-import ```jsx
@@ -1707,6 +1875,33 @@ declare global {
 		prototype: HTMLSearchcraftSliderElement;
 		new (): HTMLSearchcraftSliderElement;
 	};
+	/**
+	 * This component renders a summary box for RAG search result summaries.
+	 * When the user makes a search, a network call is made to retrieve the summary content, which is then
+	 * rendered in this box.
+	 * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+	 * @react-import ```jsx
+	 * import { SearchcraftSummaryBox } from "@searchcraft/react-sdk";
+	 * ```
+	 * @vue-import ```jsx
+	 * import { SearchcraftSummaryBox } from "@searchcraft/vue-sdk";
+	 * ```
+	 * @js-example ```html
+	 * <searchcraft-summary-box />
+	 * ```
+	 * @react-example ```jsx
+	 * <SearchcraftSummaryBox />
+	 * ```
+	 * @vue-example ```jsx
+	 * <SearchcraftSummaryBox />
+	 * ```
+	 */
+	interface HTMLSearchcraftSummaryBoxElement extends Components.SearchcraftSummaryBox, HTMLStencilElement {
+	}
+	var HTMLSearchcraftSummaryBoxElement: {
+		prototype: HTMLSearchcraftSummaryBoxElement;
+		new (): HTMLSearchcraftSummaryBoxElement;
+	};
 	/**
 	 * 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.'
 	 * @react-import ```jsx
@@ -1759,6 +1954,7 @@ declare global {
 		"searchcraft-filter-panel": HTMLSearchcraftFilterPanelElement;
 		"searchcraft-input-form": HTMLSearchcraftInputFormElement;
 		"searchcraft-input-label": HTMLSearchcraftInputLabelElement;
+		"searchcraft-loading": HTMLSearchcraftLoadingElement;
 		"searchcraft-pagination": HTMLSearchcraftPaginationElement;
 		"searchcraft-popover-button": HTMLSearchcraftPopoverButtonElement;
 		"searchcraft-popover-footer": HTMLSearchcraftPopoverFooterElement;
@@ -1771,6 +1967,7 @@ declare global {
 		"searchcraft-search-results-per-page": HTMLSearchcraftSearchResultsPerPageElement;
 		"searchcraft-select": HTMLSearchcraftSelectElement;
 		"searchcraft-slider": HTMLSearchcraftSliderElement;
+		"searchcraft-summary-box": HTMLSearchcraftSummaryBoxElement;
 		"searchcraft-theme": HTMLSearchcraftThemeElement;
 		"searchcraft-toggle-button": HTMLSearchcraftToggleButtonElement;
 	}
@@ -1781,8 +1978,15 @@ declare namespace LocalJSX {
 	 */
 	interface SearchcraftAd {
 		"adClientResponseItem"?: AdClientResponseItem;
-		"adContainerId"?: string;
-		"adSource"?: SearchcraftAdSource;
+		"adSource"?: "Custom" | "Nativo" | "adMarketplace";
+		/**
+		  * 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";
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component represents a button.
@@ -1858,6 +2062,10 @@ declare namespace LocalJSX {
 		"onFacetSelectionUpdated"?: (event: SearchcraftFacetListCustomEvent<{
 			paths: string[];
 		}>) => void;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component represents a series of filters that allows users to refine and control their search queries by applying various filter criteria.
@@ -1890,6 +2098,10 @@ declare namespace LocalJSX {
 		  * The items to filter.
 		 */
 		"items"?: FilterItem[];
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component provides a user-friendly interface for querying an indexed dataset, enabling users to easily search large collections of data.
@@ -1923,7 +2135,6 @@ declare namespace LocalJSX {
 		  * Where to place the search button.
 		 */
 		"buttonPlacement"?: "left" | "right" | "none";
-		"core"?: SearchcraftCore;
 		/**
 		  * The label rendered above the input.
 		 */
@@ -1948,6 +2159,10 @@ declare namespace LocalJSX {
 		  * The input element's placeholder value.
 		 */
 		"placeholderValue"?: string;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component serves as the input label for the searchcraft-input-form component.
@@ -1962,6 +2177,12 @@ declare namespace LocalJSX {
 		"inputLabelClassName"?: string | undefined;
 		"label"?: string;
 	}
+	/**
+	 * Renders a loading spinner/loading state for use in things like the summary box.
+	 */
+	interface SearchcraftLoading {
+		"label"?: string;
+	}
 	/**
 	 * This web component is designed to facilitate pagination of search results. Once a query is submitted, calculates the number for pages.
 	 * @react-import ```jsx
@@ -1981,6 +2202,10 @@ declare namespace LocalJSX {
 	 * ```
 	 */
 	interface SearchcraftPagination {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * Renders a button which, when clicked, turns on popover visibility.
@@ -2023,6 +2248,10 @@ declare namespace LocalJSX {
 	 * ```
 	 */
 	interface SearchcraftPopoverButton {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * A callback function responsible for rendering the button contents.
 		 */
@@ -2036,6 +2265,10 @@ declare namespace LocalJSX {
 	 * Renders the footer for the searchcraft-popover-form.
 	 */
 	interface SearchcraftPopoverFooter {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component is designed to display search results in a popover container that dynamically appears when the user interacts with a search input field, or when a popover-button is pressed.
@@ -2074,6 +2307,10 @@ declare namespace LocalJSX {
 		  * Formats the content rendered for each result.
 		 */
 		"popoverResultMappings"?: PopoverResultMappings;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * The type of popover form to render. - `inline` - Renders inline with the rest of the content on the page. The search results pop over the page content. - `fullscreen` - Renders in fullscreen view. Used together with the `searchcraft-popover-button` component. - `modal` - Renders in a modal view. Used together with the `searchcraft-popover-button` component.
 		 */
@@ -2089,6 +2326,10 @@ declare namespace LocalJSX {
 		"documentPosition"?: number;
 		"item"?: SearchClientResponseItem | undefined;
 		"popoverResultMappings"?: PopoverResultMappings | undefined;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component is designed to display a list of results within a popover interface.
@@ -2109,6 +2350,10 @@ declare namespace LocalJSX {
 		"searchClientResponseItems"?: SearchClientResponseItem[] | undefined;
 		"searchResultsPage": number;
 		"searchResultsPerPage": number;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component is designed to display the number of results returned from a search query.
@@ -2145,6 +2390,10 @@ declare namespace LocalJSX {
 	 * ```
 	 */
 	interface SearchcraftResultsInfo {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * A callback function responsible for rendering the results info.
 		 */
@@ -2163,6 +2412,10 @@ declare namespace LocalJSX {
 		 */
 		"index": number;
 		"item"?: SearchClientResponseItem;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * A callback function responsible for rendering a result.
 		 */
@@ -2214,6 +2467,10 @@ declare namespace LocalJSX {
 		  * A query that will appears when the component initializes or the search term is ''..
 		 */
 		"initialQuery"?: string;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * A callback function responsible for rendering a result. Passed to `searchcraft-search-result`.
 		 */
@@ -2243,6 +2500,10 @@ declare namespace LocalJSX {
 		  * The amount the options will increase (e.g. 20 = [20, 40, 60, 80, 100]). The base value is defined by the `searchResultsPerPage` option in the configuration.
 		 */
 		"increment"?: string | number;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 	}
 	/**
 	 * This web component is designed to allow users to select between a group of options.
@@ -2318,6 +2579,33 @@ declare namespace LocalJSX {
 		 */
 		"step"?: number;
 	}
+	/**
+	 * This component renders a summary box for RAG search result summaries.
+	 * When the user makes a search, a network call is made to retrieve the summary content, which is then
+	 * rendered in this box.
+	 * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+	 * @react-import ```jsx
+	 * import { SearchcraftSummaryBox } from "@searchcraft/react-sdk";
+	 * ```
+	 * @vue-import ```jsx
+	 * import { SearchcraftSummaryBox } from "@searchcraft/vue-sdk";
+	 * ```
+	 * @js-example ```html
+	 * <searchcraft-summary-box />
+	 * ```
+	 * @react-example ```jsx
+	 * <SearchcraftSummaryBox />
+	 * ```
+	 * @vue-example ```jsx
+	 * <SearchcraftSummaryBox />
+	 * ```
+	 */
+	interface SearchcraftSummaryBox {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
+	}
 	/**
 	 * 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.'
 	 * @react-import ```jsx
@@ -2350,6 +2638,10 @@ declare namespace LocalJSX {
 		  * When the toggle element is changed.
 		 */
 		"onToggleUpdated"?: (event: SearchcraftToggleButtonCustomEvent<boolean>) => void;
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
 		/**
 		  * The secondary label displayed below the main label.
 		 */
@@ -2363,6 +2655,7 @@ declare namespace LocalJSX {
 		"searchcraft-filter-panel": SearchcraftFilterPanel;
 		"searchcraft-input-form": SearchcraftInputForm;
 		"searchcraft-input-label": SearchcraftInputLabel;
+		"searchcraft-loading": SearchcraftLoading;
 		"searchcraft-pagination": SearchcraftPagination;
 		"searchcraft-popover-button": SearchcraftPopoverButton;
 		"searchcraft-popover-footer": SearchcraftPopoverFooter;
@@ -2375,6 +2668,7 @@ declare namespace LocalJSX {
 		"searchcraft-search-results-per-page": SearchcraftSearchResultsPerPage;
 		"searchcraft-select": SearchcraftSelect;
 		"searchcraft-slider": SearchcraftSlider;
+		"searchcraft-summary-box": SearchcraftSummaryBox;
 		"searchcraft-theme": SearchcraftTheme;
 		"searchcraft-toggle-button": SearchcraftToggleButton;
 	}
@@ -2470,6 +2764,10 @@ declare module "@stencil/core" {
 			 * ```
 			 */
 			"searchcraft-input-label": LocalJSX.SearchcraftInputLabel & JSXBase.HTMLAttributes<HTMLSearchcraftInputLabelElement>;
+			/**
+			 * Renders a loading spinner/loading state for use in things like the summary box.
+			 */
+			"searchcraft-loading": LocalJSX.SearchcraftLoading & JSXBase.HTMLAttributes<HTMLSearchcraftLoadingElement>;
 			/**
 			 * This web component is designed to facilitate pagination of search results. Once a query is submitted, calculates the number for pages.
 			 * @react-import ```jsx
@@ -2688,6 +2986,28 @@ declare module "@stencil/core" {
 			 * This web component is designed to allow users to select a value from a range defined by a minimum and maximum value. The component renders a slider interface, which can be used to visually choose a value between two boundaries.
 			 */
 			"searchcraft-slider": LocalJSX.SearchcraftSlider & JSXBase.HTMLAttributes<HTMLSearchcraftSliderElement>;
+			/**
+			 * This component renders a summary box for RAG search result summaries.
+			 * When the user makes a search, a network call is made to retrieve the summary content, which is then
+			 * rendered in this box.
+			 * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+			 * @react-import ```jsx
+			 * import { SearchcraftSummaryBox } from "@searchcraft/react-sdk";
+			 * ```
+			 * @vue-import ```jsx
+			 * import { SearchcraftSummaryBox } from "@searchcraft/vue-sdk";
+			 * ```
+			 * @js-example ```html
+			 * <searchcraft-summary-box />
+			 * ```
+			 * @react-example ```jsx
+			 * <SearchcraftSummaryBox />
+			 * ```
+			 * @vue-example ```jsx
+			 * <SearchcraftSummaryBox />
+			 * ```
+			 */
+			"searchcraft-summary-box": LocalJSX.SearchcraftSummaryBox & JSXBase.HTMLAttributes<HTMLSearchcraftSummaryBoxElement>;
 			/**
 			 * 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.'
 			 * @react-import ```jsx
@@ -2727,7 +3047,7 @@ declare module "@stencil/core" {
  * The consumer-facing `Searchcraft` class.
  */
 export declare class Searchcraft extends SearchcraftCore {
-	constructor(config: SearchcraftConfig);
+	constructor(config: SearchcraftConfig, searchcraftId?: string | undefined);
 }
 
 export {