@searchcraft/vue-sdk 0.10.2 → 0.10.4

package/dist/index.d.ts

@@ -117,6 +117,7 @@ export interface ExactMatchToggleFilterItem extends FilterItem {
 	};
 }
 export interface MostRecentToggleFilterItem extends FilterItem {
+	fieldName: string;
 	type: "mostRecentToggle";
 	options: {
 		subLabel?: string;
@@ -125,6 +126,7 @@ export interface MostRecentToggleFilterItem extends FilterItem {
 export type TemplateHtml = (strings: TemplateStringsArray, ...values: (string | number | undefined)[]) => string;
 export type SearchResultTemplate<T> = (data: T, index: number, utils: {
 	html: TemplateHtml;
+	source_index?: string;
 }) => string;
 export type SearchResultTemplateData = any;
 export type ResultsInfoTemplate = (data: {
@@ -148,6 +150,9 @@ export type PopoverButtonTemplate = (data: {
 }, utils: {
 	html: TemplateHtml;
 }) => string;
+export type ADMAdTemplate = (data: ADMAd, utils: {
+	html: TemplateHtml;
+}) => string;
 /**
  * The SearchcraftConfig object is used to initialize Searchcraft in your application.
  */
@@ -176,10 +181,6 @@ export interface SearchcraftConfig {
 	 * The maximum number of results to return per page.
 	 */
 	searchResultsPerPage?: number;
-	/**
-	 * The name of the field to use for `order_by` when sorting.
-	 */
-	indexFieldName?: string;
 	/**
 	 * Name of the ad source to use.
 	 */
@@ -200,6 +201,10 @@ export interface SearchcraftConfig {
 	 * The amount of debounce delay to add before calling the ad_container_rendered event
 	 */
 	adContainerRenderedDebounceDelay?: number;
+	/**
+	 * A callback function responsible for rendering the ADM ad containers.
+	 */
+	admAdTemplate?: ADMAdTemplate;
 	/**
 	 * The number of custom ads to render at the start of the search results page.
 	 */
@@ -261,6 +266,17 @@ 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;
+}
 /**
  * A Facet object returned in a search response.
  */
@@ -339,7 +355,7 @@ export interface SearchClientRequestProperties {
 	 * The field to order the results by (e.g., 'date_published', 'title', etc.).
 	 * Optional parameter.
 	 */
-	order_by?: string;
+	order_by?: string | null;
 	/**
 	 * The search term provided by the user.
 	 */
@@ -348,7 +364,7 @@ export interface SearchClientRequestProperties {
 	 * The sort order, which can be either 'asc' or 'desc'.
 	 * Optional parameter.
 	 */
-	sort?: "asc" | "desc";
+	sort?: "asc" | "desc" | null;
 	/**
 	 * The facet path value(s) specified by the `facets` filter items that the `searchcraft-filter-panel` renders.
 	 * There may be multiple rendered within a single filter panel.
@@ -398,6 +414,7 @@ export interface SearchIndexHit {
 	doc?: SearchDocument;
 	document_id?: string;
 	score?: number;
+	source_index?: string;
 }
 /**
  * Data document returned within a SearchResult.
@@ -409,6 +426,7 @@ export interface SearchDocument extends Record<string, string | number> {
 export interface SearchClientResponseItem {
 	id: string;
 	document: SearchDocument;
+	source_index?: string;
 }
 export interface SubscriptionEventMap {
 	ad_container_rendered: AdContainerRenderedSubscriptionEvent;
@@ -488,7 +506,7 @@ declare class MeasureClient {
 	private config;
 	private sdkInfo;
 	private userId;
-	private sessionId;
+	sessionId: string;
 	constructor(config: SearchcraftConfig, sdkInfo: SearchcraftSDKInfo, userId: string);
 	/**
 	 * Getter for the base url used by the /measure endpoints.
@@ -600,7 +618,10 @@ export interface SearchcraftStateFunctions {
 	setSearchResultsPerPage: (perPage: number) => void;
 	setSearchTerm: (searchTerm: string) => void;
 	setSearchMode: (mode: "fuzzy" | "exact") => void;
-	setSortType: (type: "asc" | "desc") => void;
+	setSortOrder: (props: {
+		orderByField: string | null;
+		sortType: "asc" | "desc" | null;
+	}) => void;
 	setHotKeyAndHotKeyModifier: (hotkey?: string, hotkeyModifier?: "ctrl" | "meta" | "alt" | "option") => void;
 }
 /**
@@ -621,12 +642,13 @@ export interface SearchcraftStateValues {
 	searchMode: "fuzzy" | "exact";
 	searchClientResponseItems: SearchClientResponseItem[];
 	searchResponseTimeTaken: number | undefined;
-	searchResponseFacetPrime: FacetPrime | undefined;
+	searchResponseFacetPrime: FacetPrime | undefined | null;
 	searchResultsCount: number;
 	searchResultsPage: number;
 	searchResultsPerPage: number;
 	searchTerm: string;
-	sortType: "asc" | "desc";
+	orderByField: string | undefined | null;
+	sortType: "asc" | "desc" | undefined | null;
 	afterInit: (state: SearchcraftState) => void;
 }
 export interface SearchcraftState extends SearchcraftStateFunctions, SearchcraftStateValues {