@searchcraft/javascript-sdk 0.9.2 → 0.9.4

package/dist/components/bundled.types.d.ts

@@ -0,0 +1,2196 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { HTMLStencilElement, JSXBase } from '@stencil/core/internal';
+
+declare enum LogLevel {
+	DEBUG = 0,
+	INFO = 1,
+	WARN = 2,
+	ERROR = 3
+}
+export interface SDKDebuggerOptions {
+	logLevel: LogLevel;
+	logFormatter?: (level: LogLevel, message: string) => string;
+}
+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 SearchcraftConfig object is used to initialize Searchcraft in your application.
+ */
+export interface SearchcraftConfig {
+	/**
+	 * Host IP Address and port number configured and created using Vektron
+	 */
+	endpointURL: string;
+	/**
+	 * Name or names of search indices configured using Vektron. Given as an array of strings
+	 */
+	index: string[];
+	/**
+	 * A unique user identifier for the end user.
+	 */
+	userId?: string;
+	/**
+	 * The Index read key provided by Vektron.
+	 */
+	readKey: string;
+	/**
+	 * The amount of delay, in milliseconds, to debounce search requests. Defaults to `0`.
+	 */
+	searchDebounceDelay?: number;
+	/**
+	 * The maximum number of results to return per page.
+	 */
+	searchResultsPerPage?: number;
+	/**
+	 * Name of the ad source to use.
+	 */
+	adSource?: "adMarketplace" | "Nativo" | "Custom" | "None";
+	/**
+	 * The maximum number of product ads to show for a single search term.
+	 */
+	admProductAdQuantity?: number;
+	/**
+	 * The maximum number of text ads to show for a single search term.
+	 */
+	admTextAdQuantity?: number;
+	/**
+	 * The adm sub value.
+	 */
+	admSub?: string;
+	/**
+	 * The number of custom ads to render at the start of the search results page.
+	 */
+	customAdStartQuantity?: number;
+	/**
+	 * The number of custom ads to render at the end of the search results page.
+	 */
+	customAdEndQuantity?: number;
+	/**
+	 * Renders a custom ad in between search results, at the specified interval.
+	 */
+	customAdInterstitialInterval?: number;
+	/**
+	 * Specifies the number of ads to be rendered in each interstitial in between search results.
+	 */
+	customAdInterstitialQuantity?: number;
+	/**
+	 * A callback function responsible for rendering the custom ad containers.
+	 */
+	customAdTemplate?: CustomAdTemplateRenderFunction;
+}
+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 CustomAdTemplateRenderData {
+	adContainerId: string;
+	searchTerm: string;
+}
+export type CustomAdTemplateRenderFunction = (data: CustomAdTemplateRenderData) => string;
+export interface AdClientResponseItem {
+	id: string;
+	adSource: SearchcraftAdSource;
+}
+/**
+ * A Facet object returned in a search response.
+ */
+export type FacetRoot = {
+	[key: string]: FacetChild[];
+};
+export type FacetPrime = FacetRoot[];
+/**
+ * Represents the structure of facets, which group search results into categories.
+ */
+export interface FacetChild {
+	count: number;
+	path: string;
+	children?: FacetChild[];
+}
+/**
+ * Types of measure requests that can be sent to the /measure/event endpoint.
+ */
+export type MeasureEventName = "sdk_initialized" | "search_requested" | "search_response_received" | "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;
+}
+/**
+ * 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;
+}
+/**
+ * The structure of a response returned from a Searchcraft operation.
+ */
+export interface SearchcraftResponse {
+	status: number;
+	data: SearchcraftResponseData | SearchcraftResponseError;
+}
+/**
+ * Error returned when a search is unsuccessful.
+ */
+export type SearchcraftResponseError = {
+	status: number;
+	message?: string;
+	code?: number;
+	hits?: [
+	];
+	facets?: null;
+	count?: number;
+	time_taken?: number;
+};
+/**
+ * Top-level result returned when a search is successful.
+ */
+export interface SearchcraftResponseData {
+	count?: number;
+	facets?: FacetPrime;
+	hits?: SearchIndexEntry[];
+	time_taken?: number;
+}
+/**
+ * Represents an entry in the search index returned as part of a search result.
+ */
+export interface SearchIndexEntry {
+	doc?: SearchDocument;
+	document_id?: string;
+	score?: number;
+}
+/**
+ * Data document returned within a SearchResult.
+ */
+export interface SearchDocument extends Record<string, string | number> {
+	id: number;
+	[key: string]: string | number;
+}
+export interface SearchClientResponseItem {
+	id: string;
+	document: SearchDocument;
+}
+export type FacetPathsForIndexField = {
+	fieldName: string;
+	value: string;
+};
+export type RangeValueForIndexField = {
+	fieldName: string;
+	value: string;
+};
+/**
+ * Parameters required to make a successful Search request.
+ */
+export type SearchParams = {
+	/**
+	 * The search mode, which can be either 'fuzzy' or 'exact'.
+	 */
+	mode: "fuzzy" | "exact";
+	/**
+	 * The starting point for the results, used for pagination.
+	 * Optional parameter.
+	 */
+	offset?: number;
+	/**
+	 * The number of results returned.
+	 * Optional parameter.
+	 */
+	limit?: number;
+	/**
+	 * The field to order the results by (e.g., 'date_published', 'title', etc.).
+	 * Optional parameter.
+	 */
+	order_by?: string;
+	/**
+	 * The search term provided by the user.
+	 */
+	searchTerm: string;
+	/**
+	 * The sort order, which can be either 'asc' or 'desc'.
+	 * Optional parameter.
+	 */
+	sort?: "asc" | "desc";
+	facetPathsForIndexFields?: Record<string, FacetPathsForIndexField>;
+	rangeValueForIndexFields?: Record<string, RangeValueForIndexField>;
+};
+export interface SubscriptionEventMap {
+	ad_container_rendered: AdContainerSubscriptionEvent;
+	query_submitted: QuerySubmittedEvent;
+	input_cleared: InputClearedEvent;
+	no_results_returned: NoResultsReturnedEvent;
+}
+export interface AdContainerSubscriptionEvent extends SubscriptionEvent {
+	name: "ad_container_rendered";
+	data: {
+		adContainerId: string;
+		adSource: SearchcraftAdSource;
+		searchTerm: string;
+	};
+}
+export interface QuerySubmittedEvent extends SubscriptionEvent {
+	name: "query_submitted";
+	data: {
+		searchTerm: string;
+	};
+}
+export interface InputClearedEvent extends SubscriptionEvent {
+	name: "input_cleared";
+}
+export interface NoResultsReturnedEvent extends SubscriptionEvent {
+	name: "no_results_returned";
+}
+export type SubscriptionEventName = keyof SubscriptionEventMap;
+export type SubscriptionEventCallback<T extends SubscriptionEventName> = (event: SubscriptionEventMap[T]) => void;
+export type UnsubscribeFunction = () => void;
+export interface SubscriptionEvent {
+	name: SubscriptionEventName;
+}
+/**
+ * A data type representing an index field value, along with properties
+ * describing how to format and display the index field value.
+ */
+export type SearchResultFieldName = {
+	/**
+	 * The index field name.
+	 */
+	fieldName: string;
+	/**
+	 * The data type to treat this index field as.
+	 */
+	dataType: "text" | "date" | "number";
+	/**
+	 * The locale to use when formatting dataType: `number`
+	 */
+	numberFormatLocale?: string;
+	/**
+	 * If it's a number, the number format to apply.
+	 * reference: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat
+	 */
+	numberFormatOptions?: Intl.NumberFormatOptions;
+	/**
+	 * A scale factor to apply to a `number` value.
+	 */
+	numberScale?: number;
+	/**
+	 * TODO: Implement DateFormatOptions, for date formatting
+	 */
+	dateFormatOptions?: unknown;
+};
+/**
+ * A data type representing the mapping of index fields, for the purpose of rendering them
+ * in search result item.
+ */
+export type SearchResultMapping = {
+	/**
+	 * The fields to map to.
+	 */
+	fieldNames: SearchResultFieldName[];
+	/**
+	 * The delimiter used to join them.
+	 */
+	delimiter?: string;
+};
+export type SearchResultMappings = {
+	body?: SearchResultMapping;
+	buttonHref?: SearchResultMapping;
+	containerHref?: SearchResultMapping;
+	footer?: SearchResultMapping;
+	imageSource?: SearchResultMapping;
+	subtitle?: SearchResultMapping;
+	title?: SearchResultMapping;
+};
+export type PopoverResultMappings = {
+	title?: SearchResultMapping;
+	subtitle?: SearchResultMapping;
+	imageSource?: SearchResultMapping;
+	imageAlt?: SearchResultMapping;
+	href?: SearchResultMapping;
+};
+export interface FilterItem {
+	type: "facets" | "dateRange" | "numericRange" | "exactMatchToggle" | "mostRecentToggle";
+	label: string;
+	options: object | null;
+}
+export interface FacetsFilterItem extends FilterItem {
+	fieldName: string;
+	type: "facets";
+	options: {
+		showSublevel: boolean;
+	};
+}
+export interface NumericFilterItem extends FilterItem {
+	fieldName: string;
+	type: "numericRange";
+	options: {
+		min: number;
+		max: number;
+		granularity: number;
+	};
+}
+export interface DateRangeFilterItem extends FilterItem {
+	fieldName: string;
+	type: "dateRange";
+	options: {
+		minDate: Date;
+		maxDate: Date;
+		granularity: "year" | "month" | "day" | "hour";
+	};
+}
+export interface ExactMatchToggleFilterItem extends FilterItem {
+	type: "exactMatchToggle";
+	options: {
+		subLabel?: string;
+	};
+}
+export interface MostRecentToggleFilterItem extends FilterItem {
+	type: "mostRecentToggle";
+	options: {
+		subLabel?: string;
+	};
+}
+declare class AdClient {
+	config: SearchcraftConfig;
+	constructor(config: SearchcraftConfig);
+	getAdsForSearchParams(_params: SearchParams): Promise<AdClientResponseItem[]>;
+}
+declare class MeasureClient {
+	private measureRequestTimeout;
+	private measureRequestsBatched;
+	private config;
+	private sdkInfo;
+	private userId;
+	private sessionId;
+	constructor(config: SearchcraftConfig, sdkInfo: SearchcraftSDKInfo, userId: string);
+	/**
+	 * Getter for the base url used by the /measure endpoints.
+	 */
+	private get baseMeasureUrl();
+	/**
+	 * Getter for the measure request user. Uses config values + navigator values.
+	 */
+	private get measureRequestUser();
+	/**
+	 * Sends a measure event to the `/measure/event` endpoint for analytics purposes.
+	 *
+	 * @param {MeasureEventName} eventName - Name of the event.
+	 * @param {Partial<MeasureRequestProperties>} properties - Additional properties to send with the event.
+	 * @param {Partial<MeasureRequestUser>} user - Additional user properites to send with the event.
+	 */
+	sendMeasureEvent: (eventName: MeasureEventName, properties?: Partial<MeasureRequestProperties>, user?: Partial<MeasureRequestUser>) => void;
+}
+declare class SearchClient {
+	private config;
+	private userId;
+	private parent;
+	constructor(parent: SearchcraftCore, config: SearchcraftConfig, userId: string);
+	/**
+	 * Getter for the base url used by the /search endpoint.
+	 */
+	private get baseSearchUrl();
+	/**
+	 * Performs a search operation.
+	 * @param {SearchParams} searchParams - The parameters for the search.
+	 */
+	getSearchResponse: (searchParams: SearchParams) => Promise<SearchcraftResponse>;
+}
+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;
+	/**
+	 * Gets items from the SearchClient and the AdClient.
+	 */
+	getItems: (searchParams: SearchParams, itemsCallback: (response: SearchcraftResponse, items: SearchClientResponseItem[]) => void, adCallback: (adClientResponseItems: AdClientResponseItem[]) => void) => void;
+}
+/**
+ * Callable functions made available by the SearchcraftStore.
+ */
+export interface SearchcraftStateFunctions {
+	addFacetPathsForIndexField: (data: FacetPathsForIndexField) => void;
+	addRangeValueForIndexField: (data: RangeValueForIndexField) => void;
+	getSearchcraftInstance: () => SearchcraftCore | undefined;
+	initialize: (searchcraft: unknown, debug?: boolean) => void;
+	removeFacetPathsForIndexField: (fieldName: string) => void;
+	removeRangeValueForIndexField: (fieldName: string) => void;
+	resetFacetPaths: () => void;
+	search: () => Promise<void>;
+	setPopoverVisibility: (isVisible: boolean) => void;
+	setSearchClientResponseItems: (results: SearchClientResponseItem[]) => void;
+	setSearchResultsPage: (page: number) => void;
+	setSearchResultsPerPage: (perPage: number) => void;
+	setSearchTerm: (searchTerm: string) => void;
+	setSearchMode: (mode: "fuzzy" | "exact") => void;
+	setSortType: (type: "asc" | "desc") => void;
+}
+/**
+ * Values stored in SearchcraftStore.
+ */
+export interface SearchcraftStateValues {
+	adClientResponseItems: AdClientResponseItem[];
+	core: SearchcraftCore | undefined;
+	logger: Logger | undefined;
+	facetPathsForIndexFields: Record<string, FacetPathsForIndexField>;
+	isPopoverVisible: boolean;
+	isSearchInProgress: boolean;
+	rangeValueForIndexFields: Record<string, RangeValueForIndexField>;
+	searchMode: "fuzzy" | "exact";
+	searchClientResponseItems: SearchClientResponseItem[];
+	searchResponseTimeTaken: number | undefined;
+	searchResponseFacetPrime: FacetPrime | undefined;
+	searchResultsCount: number;
+	searchResultsPage: number;
+	searchResultsPerPage: number;
+	searchTerm: string;
+	sortType: "asc" | "desc";
+}
+export interface SearchcraftState extends SearchcraftStateFunctions, SearchcraftStateValues {
+}
+export declare const searchcraftStore: import("zustand").StoreApi<SearchcraftState>;
+export declare function parseCustomStyles(styles: string | Record<string, string>): Record<string, string>;
+export declare function serializeStyles(styles: Record<string, Record<string, string>>): string;
+export type SearchcraftSelectOption = {
+	label: string;
+	value: string | number;
+	selected?: boolean;
+};
+export namespace Components {
+	/**
+	 * An inline ad meant to be rendered in a list of search results.
+	 */
+	interface SearchcraftAd {
+		"adClientResponseItem"?: AdClientResponseItem;
+		"adSource": SearchcraftAdSource;
+	}
+	/**
+	 * This web component is designed to display detailed information for a single search result.
+	 * Once a query is submitted, the component formats and presents the result.
+	 * It is consumed within the `searchcraft-base-search-results` component.
+	 */
+	interface SearchcraftBaseSearchResult {
+		/**
+		  * The relationship between the current document and the link for the button rendered when containerHref is not present.
+		 */
+		"buttonRel"?: "noreferrer" | "noopener" | "nofollow";
+		/**
+		  * Where to open the link for the button rendered when containerHref is not present.
+		 */
+		"buttonTarget": "_blank" | "_self" | "_top" | "_parent";
+		/**
+		  * The relationship between the current document and the link for the containing element.
+		 */
+		"containerRel"?: "noreferrer" | "noopener" | "nofollow";
+		/**
+		  * Where to open the link for the containing element.
+		 */
+		"containerTarget": "_blank" | "_self" | "_top" | "_parent";
+		/**
+		  * A custom styles object.
+		 */
+		"customStyles"?: string;
+		/**
+		  * The position in the document. Used with the "document_clicked" measure event.
+		 */
+		"documentPosition": number;
+		/**
+		  * The placement of the image.
+		 */
+		"imagePlacement": "left" | "right";
+		"item"?: SearchClientResponseItem;
+		"searchResultMappings"?: SearchResultMappings;
+	}
+	/**
+	 * This web component is responsible for displaying the results of a search query.
+	 * Once a query is submitted, the component formats and presents an ordered list of the results.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-base-search-results
+	 *   ad-interval="4"
+	 *   place-ad-at-start="false"
+	 *   result-image-placement="right"
+	 * />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const baseSearchResults = document.querySelector('searchcraft-base-search-results');
+	 * baseSearchResults.searchResultMappings = containerHref: {
+	 *   fieldNames: [
+	 *    {
+	 *      fieldName: 'canonical_link',
+	 *      dataType: 'text',
+	 *    },
+	 *  ],
+	 * };
+	 * baseSearchResults.addEventListener('noResults', () => {
+	 *   console.log('No search results found');
+	 * });
+	 * ```
+	 */
+	interface SearchcraftBaseSearchResults {
+		/**
+		  * The label for the button rendered when containerHref is not present for each result.
+		 */
+		"buttonLabel"?: string;
+		/**
+		  * The relationship between the current document and the link for the button rendered when containerHref is not present for each result.
+		 */
+		"buttonRel"?: "noreferrer" | "noopener" | "nofollow";
+		/**
+		  * Where to open the link for the button rendered when containerHref is not present for each result.
+		 */
+		"buttonTarget": "_blank" | "_self" | "_top" | "_parent";
+		/**
+		  * The relationship between the current document and the link for the containing element for each result.
+		 */
+		"containerRel"?: "noreferrer" | "noopener" | "nofollow";
+		/**
+		  * Where to open the link for the containing element for each result.
+		 */
+		"containerTarget": "_blank" | "_self" | "_top" | "_parent";
+		/**
+		  * A custom styles object.
+		 */
+		"customStylesForResults"?: string | Record<string, Record<string, string>>;
+		/**
+		  * The placement of the image for each result.
+		 */
+		"resultImagePlacement": "left" | "right";
+		/**
+		  * Formats the content rendered for each result.
+		 */
+		"searchResultMappings"?: SearchResultMappings;
+	}
+	/**
+	 * This web component represents a button to be consumed within the `search-input-form` component.
+	 * It provides a clear, interactive way for users to submit search queries or trigger actions in a search interface.
+	 * It is consumed within the `searchcraft-input-form` component.
+	 */
+	interface SearchcraftButton {
+		/**
+		  * Whether the button is disabled.
+		 */
+		"disabled"?: boolean;
+		/**
+		  * Controls the visual representation of the button.
+		 */
+		"hierarchy"?: "primary" | "tertiary";
+		/**
+		  * The icon element.
+		 */
+		"icon"?: Element;
+		/**
+		  * Should the button only display an icon.
+		 */
+		"iconOnly"?: boolean;
+		/**
+		  * The position of the icon.
+		 */
+		"iconPosition"?: "left" | "right";
+		/**
+		  * The label for the button.
+		 */
+		"label": string;
+		/**
+		  * The type of the button.
+		 */
+		"type"?: "submit" | "reset" | "button";
+	}
+	/**
+	 * This web component is designed to display a user-friendly error message when a search query fails, providing clear feedback to users and enhancing their experience when an issue arises during the search process.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-error-message error-message="No search results found for query" />
+	 * ```
+	 */
+	interface SearchcraftErrorMessage {
+		/**
+		  * The error message.
+		 */
+		"errorMessage"?: string;
+	}
+	/**
+	 * This web component is designed to display facets in a search interface, allowing users to refine their search results by applying filters based on various attributes.
+	 * It is consumed within the `searchcraft-filter-panel`.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-facet-list field-name="title" />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const facetList = document.querySelector('searchcraft-facet-list');
+	 * facetList.addEventListener('facetSelectionUpdated', () => {
+	 *   console.log('Facet selection updated');
+	 * });
+	 * ```
+	 */
+	interface SearchcraftFacetList {
+		/**
+		  * The name of the field where facets are applied.
+		 */
+		"fieldName": string;
+	}
+	/**
+	 * This web component represents a series of filters that allows users to refine and control their search queries by applying various filter criteria.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-filter-panel />
+	 * ```
+	 */
+	interface SearchcraftFilterPanel {
+		/**
+		  * The items to filter.
+		 */
+		"items": FilterItem[];
+	}
+	/**
+	 * This web component provides a user-friendly interface for querying an indexed dataset, enabling users to easily search large collections of data.
+	 * It abstracts the complexities of index-based searching, making it accessible to users of all technical levels.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-input-form placeholder-value="Search here" />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const searchInputForm = document.querySelector('searchcraft-input-form');
+	 * ```
+	 */
+	interface SearchcraftInputForm {
+		/**
+		  * Whether or not to automatically submit the search term when the input changes.
+		 */
+		"autoSearch": boolean;
+		/**
+		  * The label for the submit button.
+		 */
+		"buttonLabel"?: string;
+		/**
+		  * Where to place the search button.
+		 */
+		"buttonPlacement": "left" | "right" | "none";
+		"core"?: SearchcraftCore;
+		/**
+		  * A custom styles object to be applied to the input element.
+		 */
+		"customStyles": string | Record<string, string>;
+		/**
+		  * The label rendered above the input.
+		 */
+		"inputLabel"?: string;
+		/**
+		  * 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.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-input-label label="Search" />
+	 * ```
+	 */
+	interface SearchcraftInputLabel {
+		/**
+		  * The classname applied to the label element.
+		 */
+		"inputLabelClassName"?: string | undefined;
+		"label": string;
+	}
+	/**
+	 * This web component is designed to facilitate pagination of search results.
+	 * Once a query is submitted, calculates the number for pages.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-pagination />
+	 * ```
+	 */
+	interface SearchcraftPagination {
+		/**
+		  * The custom styles object.
+		 */
+		"customStyles"?: string;
+	}
+	/**
+	 * Renders a button which, when clicked, turns on popover visibility.
+	 */
+	interface SearchcraftPopoverButton {
+	}
+	/**
+	 * 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.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-popover-form type="fullscreen" />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const popoverForm = document.querySelector('searchcraft-popover-form');
+	 * popoverForm.popoverResultMappings = {
+	 *  containerHref: {
+	 *   fieldNames: [
+	 *    {
+	 *      fieldName: 'canonical_link',
+	 *      dataType: 'text',
+	 *    },
+	 *  ],
+	 *  };
+	 * ```
+	 */
+	interface SearchcraftPopoverForm {
+		/**
+		  * The hotkey that activates the popover.
+		 */
+		"hotkey": string;
+		/**
+		  * The hotkey modifier that activates the popover. Used together with the `hotkey` prop.
+		 */
+		"hotkeyModifier": "ctrl" | "meta" | "alt" | "option";
+		/**
+		  * Formats the content rendered for each result.
+		 */
+		"popoverResultMappings"?: PopoverResultMappings;
+		/**
+		  * 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.
+		 */
+		"type": "inline" | "fullscreen" | "modal";
+	}
+	/**
+	 * A single list item rendered in a searchcraft-popover-list-view.
+	 */
+	interface SearchcraftPopoverListItem {
+		/**
+		  * The document position relative to the search results (For Measure)
+		 */
+		"documentPosition": number;
+		"item": SearchClientResponseItem | undefined;
+		"popoverResultMappings": PopoverResultMappings | undefined;
+	}
+	/**
+	 * This web component is designed to display a list of results within a popover interface.
+	 * It is consumed within the `searchcraft-popover-form` component.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-popover-list-view />
+	 * ```
+	 */
+	interface SearchcraftPopoverListView {
+		"adClientResponseItems": AdClientResponseItem[] | undefined;
+		/**
+		  * The mappings that define how the data in the documents are mapped to the list-view-item elements.
+		 */
+		"popoverResultMappings": PopoverResultMappings | undefined;
+		/**
+		  * The items to render in the list view.
+		 */
+		"searchClientResponseItems": SearchClientResponseItem[] | undefined;
+		"searchResultsPage": number;
+		"searchResultsPerPage": number;
+	}
+	/**
+	 * This web component is designed to display the number of results returned from a search query.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <script>
+	 *  const resultsInfo = document.querySelector('searchcraft-results-info');
+	 *  resultsInfo.customFormatter = (range, count, responseTime) =>
+	 *    `${range[0]}-${range[1]} of ${count} results in ${responseTime}ms`;
+	 * </script>
+	 * <searchcraft-results-info />
+	 * ```
+	 */
+	interface SearchcraftResultsInfo {
+		/**
+		  * The custom formatter for the resulting string.
+		  * @example ```ts  resultsInfo.customFormatter = (range, count, responseTime) =>    `${range[0]}-${range[1]} of ${count} results in ${responseTime}ms`; ```
+		 */
+		"customFormatter"?: (range: [
+			string,
+			string
+		], count: string, responseTime: string) => void;
+		/**
+		  * The custom styles object.
+		 */
+		"customStyles"?: string;
+	}
+	/**
+	 * This web component is designed to choose the number of search results displayed.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-search-results-per-page increment="20" />
+	 * ```
+	 */
+	interface SearchcraftSearchResultsPerPage {
+		/**
+		  * The custom styles object.
+		 */
+		"customStyles"?: string;
+		/**
+		  * 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;
+	}
+	/**
+	 * This web component is designed to allow users to select between a group of options.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-select
+	 *  inputId="searchcraft-select"
+	 *  name="searchcraft-select"
+	 *  options="[{ label: 'label', value: 'value' }]"
+	 * />
+	 * ```
+	 */
+	interface SearchcraftSelect {
+		/**
+		  * The caption displayed below the select input.
+		 */
+		"caption"?: string;
+		/**
+		  * A custom styles object.
+		 */
+		"customStyles"?: string;
+		/**
+		  * Whether the select input is disabled.
+		 */
+		"disabled"?: boolean;
+		/**
+		  * The ID for the select input.
+		 */
+		"inputId": string;
+		/**
+		  * The label of the select input.
+		 */
+		"label"?: string;
+		/**
+		  * The ID for the label of the select input.
+		 */
+		"labelId"?: string;
+		/**
+		  * The name of the select input.
+		 */
+		"name": string;
+		/**
+		  * The options for the select input.
+		 */
+		"options": SearchcraftSelectOption[] | string;
+	}
+	/**
+	 * 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.
+	 * It is consumed by the `searchcraft-filter-panel` component.
+	 */
+	interface SearchcraftSlider {
+		/**
+		  * The type of data allowed.
+		 */
+		"dataType": "number" | "date";
+		/**
+		  * The granularity that the value must adhere to.
+		 */
+		"granularity": number;
+		/**
+		  * The maximum value allowed.
+		 */
+		"max": number;
+		/**
+		  * The minimum value allowed.
+		 */
+		"min": number;
+	}
+	/**
+	 * This web component adds Searchcraft's built-in css theme to your page's <head> tag.
+	 * It does not render anything visible, its only function is to manage the css styles on the page.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-theme theme="light" custom-theme="{}" />
+	 * ```
+	 */
+	interface SearchcraftTheme {
+		/**
+		  * The custom theme configuration object.
+		 */
+		"customTheme"?: string;
+		/**
+		  * The name of the theme.
+		 */
+		"theme"?: string;
+	}
+	/**
+	 * This web component simulates a light switch functionality, providing a simple and intuitive toggle between two states—on and off.
+	 * It is consumed within the `searchcraft-filter-panel` component.
+	 */
+	interface SearchcraftToggleButton {
+		/**
+		  * The label.
+		 */
+		"label": string;
+		/**
+		  * The secondary label displayed below the main label.
+		 */
+		"subLabel": string | undefined;
+	}
+}
+export interface SearchcraftButtonCustomEvent<T> extends CustomEvent<T> {
+	detail: T;
+	target: HTMLSearchcraftButtonElement;
+}
+export interface SearchcraftFacetListCustomEvent<T> extends CustomEvent<T> {
+	detail: T;
+	target: HTMLSearchcraftFacetListElement;
+}
+export interface SearchcraftInputFormCustomEvent<T> extends CustomEvent<T> {
+	detail: T;
+	target: HTMLSearchcraftInputFormElement;
+}
+export interface SearchcraftSelectCustomEvent<T> extends CustomEvent<T> {
+	detail: T;
+	target: HTMLSearchcraftSelectElement;
+}
+export interface SearchcraftSliderCustomEvent<T> extends CustomEvent<T> {
+	detail: T;
+	target: HTMLSearchcraftSliderElement;
+}
+export interface SearchcraftToggleButtonCustomEvent<T> extends CustomEvent<T> {
+	detail: T;
+	target: HTMLSearchcraftToggleButtonElement;
+}
+declare global {
+	/**
+	 * An inline ad meant to be rendered in a list of search results.
+	 */
+	interface HTMLSearchcraftAdElement extends Components.SearchcraftAd, HTMLStencilElement {
+	}
+	var HTMLSearchcraftAdElement: {
+		prototype: HTMLSearchcraftAdElement;
+		new (): HTMLSearchcraftAdElement;
+	};
+	/**
+	 * This web component is designed to display detailed information for a single search result.
+	 * Once a query is submitted, the component formats and presents the result.
+	 * It is consumed within the `searchcraft-base-search-results` component.
+	 */
+	interface HTMLSearchcraftBaseSearchResultElement extends Components.SearchcraftBaseSearchResult, HTMLStencilElement {
+	}
+	var HTMLSearchcraftBaseSearchResultElement: {
+		prototype: HTMLSearchcraftBaseSearchResultElement;
+		new (): HTMLSearchcraftBaseSearchResultElement;
+	};
+	/**
+	 * This web component is responsible for displaying the results of a search query.
+	 * Once a query is submitted, the component formats and presents an ordered list of the results.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-base-search-results
+	 *   ad-interval="4"
+	 *   place-ad-at-start="false"
+	 *   result-image-placement="right"
+	 * />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const baseSearchResults = document.querySelector('searchcraft-base-search-results');
+	 * baseSearchResults.searchResultMappings = containerHref: {
+	 *   fieldNames: [
+	 *    {
+	 *      fieldName: 'canonical_link',
+	 *      dataType: 'text',
+	 *    },
+	 *  ],
+	 * };
+	 * baseSearchResults.addEventListener('noResults', () => {
+	 *   console.log('No search results found');
+	 * });
+	 * ```
+	 */
+	interface HTMLSearchcraftBaseSearchResultsElement extends Components.SearchcraftBaseSearchResults, HTMLStencilElement {
+	}
+	var HTMLSearchcraftBaseSearchResultsElement: {
+		prototype: HTMLSearchcraftBaseSearchResultsElement;
+		new (): HTMLSearchcraftBaseSearchResultsElement;
+	};
+	interface HTMLSearchcraftButtonElementEventMap {
+		"buttonClick": void;
+	}
+	/**
+	 * This web component represents a button to be consumed within the `search-input-form` component.
+	 * It provides a clear, interactive way for users to submit search queries or trigger actions in a search interface.
+	 * It is consumed within the `searchcraft-input-form` component.
+	 */
+	interface HTMLSearchcraftButtonElement extends Components.SearchcraftButton, HTMLStencilElement {
+		addEventListener<K extends keyof HTMLSearchcraftButtonElementEventMap>(type: K, listener: (this: HTMLSearchcraftButtonElement, ev: SearchcraftButtonCustomEvent<HTMLSearchcraftButtonElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLSearchcraftButtonElementEventMap>(type: K, listener: (this: HTMLSearchcraftButtonElement, ev: SearchcraftButtonCustomEvent<HTMLSearchcraftButtonElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+	}
+	var HTMLSearchcraftButtonElement: {
+		prototype: HTMLSearchcraftButtonElement;
+		new (): HTMLSearchcraftButtonElement;
+	};
+	/**
+	 * This web component is designed to display a user-friendly error message when a search query fails, providing clear feedback to users and enhancing their experience when an issue arises during the search process.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-error-message error-message="No search results found for query" />
+	 * ```
+	 */
+	interface HTMLSearchcraftErrorMessageElement extends Components.SearchcraftErrorMessage, HTMLStencilElement {
+	}
+	var HTMLSearchcraftErrorMessageElement: {
+		prototype: HTMLSearchcraftErrorMessageElement;
+		new (): HTMLSearchcraftErrorMessageElement;
+	};
+	interface HTMLSearchcraftFacetListElementEventMap {
+		"facetSelectionUpdated": {
+			paths: string[];
+		};
+	}
+	/**
+	 * This web component is designed to display facets in a search interface, allowing users to refine their search results by applying filters based on various attributes.
+	 * It is consumed within the `searchcraft-filter-panel`.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-facet-list field-name="title" />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const facetList = document.querySelector('searchcraft-facet-list');
+	 * facetList.addEventListener('facetSelectionUpdated', () => {
+	 *   console.log('Facet selection updated');
+	 * });
+	 * ```
+	 */
+	interface HTMLSearchcraftFacetListElement extends Components.SearchcraftFacetList, HTMLStencilElement {
+		addEventListener<K extends keyof HTMLSearchcraftFacetListElementEventMap>(type: K, listener: (this: HTMLSearchcraftFacetListElement, ev: SearchcraftFacetListCustomEvent<HTMLSearchcraftFacetListElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLSearchcraftFacetListElementEventMap>(type: K, listener: (this: HTMLSearchcraftFacetListElement, ev: SearchcraftFacetListCustomEvent<HTMLSearchcraftFacetListElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+	}
+	var HTMLSearchcraftFacetListElement: {
+		prototype: HTMLSearchcraftFacetListElement;
+		new (): HTMLSearchcraftFacetListElement;
+	};
+	/**
+	 * This web component represents a series of filters that allows users to refine and control their search queries by applying various filter criteria.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-filter-panel />
+	 * ```
+	 */
+	interface HTMLSearchcraftFilterPanelElement extends Components.SearchcraftFilterPanel, HTMLStencilElement {
+	}
+	var HTMLSearchcraftFilterPanelElement: {
+		prototype: HTMLSearchcraftFilterPanelElement;
+		new (): HTMLSearchcraftFilterPanelElement;
+	};
+	interface HTMLSearchcraftInputFormElementEventMap {
+		"inputFocus": void;
+		"inputBlur": void;
+		"inputInit": void;
+	}
+	/**
+	 * This web component provides a user-friendly interface for querying an indexed dataset, enabling users to easily search large collections of data.
+	 * It abstracts the complexities of index-based searching, making it accessible to users of all technical levels.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-input-form placeholder-value="Search here" />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const searchInputForm = document.querySelector('searchcraft-input-form');
+	 * ```
+	 */
+	interface HTMLSearchcraftInputFormElement extends Components.SearchcraftInputForm, HTMLStencilElement {
+		addEventListener<K extends keyof HTMLSearchcraftInputFormElementEventMap>(type: K, listener: (this: HTMLSearchcraftInputFormElement, ev: SearchcraftInputFormCustomEvent<HTMLSearchcraftInputFormElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLSearchcraftInputFormElementEventMap>(type: K, listener: (this: HTMLSearchcraftInputFormElement, ev: SearchcraftInputFormCustomEvent<HTMLSearchcraftInputFormElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+	}
+	var HTMLSearchcraftInputFormElement: {
+		prototype: HTMLSearchcraftInputFormElement;
+		new (): HTMLSearchcraftInputFormElement;
+	};
+	/**
+	 * This web component serves as the input label for the searchcraft-input-form component.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-input-label label="Search" />
+	 * ```
+	 */
+	interface HTMLSearchcraftInputLabelElement extends Components.SearchcraftInputLabel, HTMLStencilElement {
+	}
+	var HTMLSearchcraftInputLabelElement: {
+		prototype: HTMLSearchcraftInputLabelElement;
+		new (): HTMLSearchcraftInputLabelElement;
+	};
+	/**
+	 * This web component is designed to facilitate pagination of search results.
+	 * Once a query is submitted, calculates the number for pages.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-pagination />
+	 * ```
+	 */
+	interface HTMLSearchcraftPaginationElement extends Components.SearchcraftPagination, HTMLStencilElement {
+	}
+	var HTMLSearchcraftPaginationElement: {
+		prototype: HTMLSearchcraftPaginationElement;
+		new (): HTMLSearchcraftPaginationElement;
+	};
+	/**
+	 * Renders a button which, when clicked, turns on popover visibility.
+	 */
+	interface HTMLSearchcraftPopoverButtonElement extends Components.SearchcraftPopoverButton, HTMLStencilElement {
+	}
+	var HTMLSearchcraftPopoverButtonElement: {
+		prototype: HTMLSearchcraftPopoverButtonElement;
+		new (): HTMLSearchcraftPopoverButtonElement;
+	};
+	/**
+	 * 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.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-popover-form type="fullscreen" />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const popoverForm = document.querySelector('searchcraft-popover-form');
+	 * popoverForm.popoverResultMappings = {
+	 *  containerHref: {
+	 *   fieldNames: [
+	 *    {
+	 *      fieldName: 'canonical_link',
+	 *      dataType: 'text',
+	 *    },
+	 *  ],
+	 *  };
+	 * ```
+	 */
+	interface HTMLSearchcraftPopoverFormElement extends Components.SearchcraftPopoverForm, HTMLStencilElement {
+	}
+	var HTMLSearchcraftPopoverFormElement: {
+		prototype: HTMLSearchcraftPopoverFormElement;
+		new (): HTMLSearchcraftPopoverFormElement;
+	};
+	/**
+	 * A single list item rendered in a searchcraft-popover-list-view.
+	 */
+	interface HTMLSearchcraftPopoverListItemElement extends Components.SearchcraftPopoverListItem, HTMLStencilElement {
+	}
+	var HTMLSearchcraftPopoverListItemElement: {
+		prototype: HTMLSearchcraftPopoverListItemElement;
+		new (): HTMLSearchcraftPopoverListItemElement;
+	};
+	/**
+	 * This web component is designed to display a list of results within a popover interface.
+	 * It is consumed within the `searchcraft-popover-form` component.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-popover-list-view />
+	 * ```
+	 */
+	interface HTMLSearchcraftPopoverListViewElement extends Components.SearchcraftPopoverListView, HTMLStencilElement {
+	}
+	var HTMLSearchcraftPopoverListViewElement: {
+		prototype: HTMLSearchcraftPopoverListViewElement;
+		new (): HTMLSearchcraftPopoverListViewElement;
+	};
+	/**
+	 * This web component is designed to display the number of results returned from a search query.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <script>
+	 *  const resultsInfo = document.querySelector('searchcraft-results-info');
+	 *  resultsInfo.customFormatter = (range, count, responseTime) =>
+	 *    `${range[0]}-${range[1]} of ${count} results in ${responseTime}ms`;
+	 * </script>
+	 * <searchcraft-results-info />
+	 * ```
+	 */
+	interface HTMLSearchcraftResultsInfoElement extends Components.SearchcraftResultsInfo, HTMLStencilElement {
+	}
+	var HTMLSearchcraftResultsInfoElement: {
+		prototype: HTMLSearchcraftResultsInfoElement;
+		new (): HTMLSearchcraftResultsInfoElement;
+	};
+	/**
+	 * This web component is designed to choose the number of search results displayed.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-search-results-per-page increment="20" />
+	 * ```
+	 */
+	interface HTMLSearchcraftSearchResultsPerPageElement extends Components.SearchcraftSearchResultsPerPage, HTMLStencilElement {
+	}
+	var HTMLSearchcraftSearchResultsPerPageElement: {
+		prototype: HTMLSearchcraftSearchResultsPerPageElement;
+		new (): HTMLSearchcraftSearchResultsPerPageElement;
+	};
+	interface HTMLSearchcraftSelectElementEventMap {
+		"selectChange": string;
+	}
+	/**
+	 * This web component is designed to allow users to select between a group of options.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-select
+	 *  inputId="searchcraft-select"
+	 *  name="searchcraft-select"
+	 *  options="[{ label: 'label', value: 'value' }]"
+	 * />
+	 * ```
+	 */
+	interface HTMLSearchcraftSelectElement extends Components.SearchcraftSelect, HTMLStencilElement {
+		addEventListener<K extends keyof HTMLSearchcraftSelectElementEventMap>(type: K, listener: (this: HTMLSearchcraftSelectElement, ev: SearchcraftSelectCustomEvent<HTMLSearchcraftSelectElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLSearchcraftSelectElementEventMap>(type: K, listener: (this: HTMLSearchcraftSelectElement, ev: SearchcraftSelectCustomEvent<HTMLSearchcraftSelectElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+	}
+	var HTMLSearchcraftSelectElement: {
+		prototype: HTMLSearchcraftSelectElement;
+		new (): HTMLSearchcraftSelectElement;
+	};
+	interface HTMLSearchcraftSliderElementEventMap {
+		"rangeChanged": any;
+	}
+	/**
+	 * 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.
+	 * It is consumed by the `searchcraft-filter-panel` component.
+	 */
+	interface HTMLSearchcraftSliderElement extends Components.SearchcraftSlider, HTMLStencilElement {
+		addEventListener<K extends keyof HTMLSearchcraftSliderElementEventMap>(type: K, listener: (this: HTMLSearchcraftSliderElement, ev: SearchcraftSliderCustomEvent<HTMLSearchcraftSliderElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLSearchcraftSliderElementEventMap>(type: K, listener: (this: HTMLSearchcraftSliderElement, ev: SearchcraftSliderCustomEvent<HTMLSearchcraftSliderElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+	}
+	var HTMLSearchcraftSliderElement: {
+		prototype: HTMLSearchcraftSliderElement;
+		new (): HTMLSearchcraftSliderElement;
+	};
+	/**
+	 * This web component adds Searchcraft's built-in css theme to your page's <head> tag.
+	 * It does not render anything visible, its only function is to manage the css styles on the page.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-theme theme="light" custom-theme="{}" />
+	 * ```
+	 */
+	interface HTMLSearchcraftThemeElement extends Components.SearchcraftTheme, HTMLStencilElement {
+	}
+	var HTMLSearchcraftThemeElement: {
+		prototype: HTMLSearchcraftThemeElement;
+		new (): HTMLSearchcraftThemeElement;
+	};
+	interface HTMLSearchcraftToggleButtonElementEventMap {
+		"toggleUpdated": boolean;
+	}
+	/**
+	 * This web component simulates a light switch functionality, providing a simple and intuitive toggle between two states—on and off.
+	 * It is consumed within the `searchcraft-filter-panel` component.
+	 */
+	interface HTMLSearchcraftToggleButtonElement extends Components.SearchcraftToggleButton, HTMLStencilElement {
+		addEventListener<K extends keyof HTMLSearchcraftToggleButtonElementEventMap>(type: K, listener: (this: HTMLSearchcraftToggleButtonElement, ev: SearchcraftToggleButtonCustomEvent<HTMLSearchcraftToggleButtonElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+		addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLSearchcraftToggleButtonElementEventMap>(type: K, listener: (this: HTMLSearchcraftToggleButtonElement, ev: SearchcraftToggleButtonCustomEvent<HTMLSearchcraftToggleButtonElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+		removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+	}
+	var HTMLSearchcraftToggleButtonElement: {
+		prototype: HTMLSearchcraftToggleButtonElement;
+		new (): HTMLSearchcraftToggleButtonElement;
+	};
+	interface HTMLElementTagNameMap {
+		"searchcraft-ad": HTMLSearchcraftAdElement;
+		"searchcraft-base-search-result": HTMLSearchcraftBaseSearchResultElement;
+		"searchcraft-base-search-results": HTMLSearchcraftBaseSearchResultsElement;
+		"searchcraft-button": HTMLSearchcraftButtonElement;
+		"searchcraft-error-message": HTMLSearchcraftErrorMessageElement;
+		"searchcraft-facet-list": HTMLSearchcraftFacetListElement;
+		"searchcraft-filter-panel": HTMLSearchcraftFilterPanelElement;
+		"searchcraft-input-form": HTMLSearchcraftInputFormElement;
+		"searchcraft-input-label": HTMLSearchcraftInputLabelElement;
+		"searchcraft-pagination": HTMLSearchcraftPaginationElement;
+		"searchcraft-popover-button": HTMLSearchcraftPopoverButtonElement;
+		"searchcraft-popover-form": HTMLSearchcraftPopoverFormElement;
+		"searchcraft-popover-list-item": HTMLSearchcraftPopoverListItemElement;
+		"searchcraft-popover-list-view": HTMLSearchcraftPopoverListViewElement;
+		"searchcraft-results-info": HTMLSearchcraftResultsInfoElement;
+		"searchcraft-search-results-per-page": HTMLSearchcraftSearchResultsPerPageElement;
+		"searchcraft-select": HTMLSearchcraftSelectElement;
+		"searchcraft-slider": HTMLSearchcraftSliderElement;
+		"searchcraft-theme": HTMLSearchcraftThemeElement;
+		"searchcraft-toggle-button": HTMLSearchcraftToggleButtonElement;
+	}
+}
+declare namespace LocalJSX {
+	/**
+	 * An inline ad meant to be rendered in a list of search results.
+	 */
+	interface SearchcraftAd {
+		"adClientResponseItem"?: AdClientResponseItem;
+		"adSource"?: SearchcraftAdSource;
+	}
+	/**
+	 * This web component is designed to display detailed information for a single search result.
+	 * Once a query is submitted, the component formats and presents the result.
+	 * It is consumed within the `searchcraft-base-search-results` component.
+	 */
+	interface SearchcraftBaseSearchResult {
+		/**
+		  * The relationship between the current document and the link for the button rendered when containerHref is not present.
+		 */
+		"buttonRel"?: "noreferrer" | "noopener" | "nofollow";
+		/**
+		  * Where to open the link for the button rendered when containerHref is not present.
+		 */
+		"buttonTarget"?: "_blank" | "_self" | "_top" | "_parent";
+		/**
+		  * The relationship between the current document and the link for the containing element.
+		 */
+		"containerRel"?: "noreferrer" | "noopener" | "nofollow";
+		/**
+		  * Where to open the link for the containing element.
+		 */
+		"containerTarget"?: "_blank" | "_self" | "_top" | "_parent";
+		/**
+		  * A custom styles object.
+		 */
+		"customStyles"?: string;
+		/**
+		  * The position in the document. Used with the "document_clicked" measure event.
+		 */
+		"documentPosition"?: number;
+		/**
+		  * The placement of the image.
+		 */
+		"imagePlacement"?: "left" | "right";
+		"item"?: SearchClientResponseItem;
+		"searchResultMappings"?: SearchResultMappings;
+	}
+	/**
+	 * This web component is responsible for displaying the results of a search query.
+	 * Once a query is submitted, the component formats and presents an ordered list of the results.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-base-search-results
+	 *   ad-interval="4"
+	 *   place-ad-at-start="false"
+	 *   result-image-placement="right"
+	 * />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const baseSearchResults = document.querySelector('searchcraft-base-search-results');
+	 * baseSearchResults.searchResultMappings = containerHref: {
+	 *   fieldNames: [
+	 *    {
+	 *      fieldName: 'canonical_link',
+	 *      dataType: 'text',
+	 *    },
+	 *  ],
+	 * };
+	 * baseSearchResults.addEventListener('noResults', () => {
+	 *   console.log('No search results found');
+	 * });
+	 * ```
+	 */
+	interface SearchcraftBaseSearchResults {
+		/**
+		  * The label for the button rendered when containerHref is not present for each result.
+		 */
+		"buttonLabel"?: string;
+		/**
+		  * The relationship between the current document and the link for the button rendered when containerHref is not present for each result.
+		 */
+		"buttonRel"?: "noreferrer" | "noopener" | "nofollow";
+		/**
+		  * Where to open the link for the button rendered when containerHref is not present for each result.
+		 */
+		"buttonTarget"?: "_blank" | "_self" | "_top" | "_parent";
+		/**
+		  * The relationship between the current document and the link for the containing element for each result.
+		 */
+		"containerRel"?: "noreferrer" | "noopener" | "nofollow";
+		/**
+		  * Where to open the link for the containing element for each result.
+		 */
+		"containerTarget"?: "_blank" | "_self" | "_top" | "_parent";
+		/**
+		  * A custom styles object.
+		 */
+		"customStylesForResults"?: string | Record<string, Record<string, string>>;
+		/**
+		  * The placement of the image for each result.
+		 */
+		"resultImagePlacement"?: "left" | "right";
+		/**
+		  * Formats the content rendered for each result.
+		 */
+		"searchResultMappings"?: SearchResultMappings;
+	}
+	/**
+	 * This web component represents a button to be consumed within the `search-input-form` component.
+	 * It provides a clear, interactive way for users to submit search queries or trigger actions in a search interface.
+	 * It is consumed within the `searchcraft-input-form` component.
+	 */
+	interface SearchcraftButton {
+		/**
+		  * Whether the button is disabled.
+		 */
+		"disabled"?: boolean;
+		/**
+		  * Controls the visual representation of the button.
+		 */
+		"hierarchy"?: "primary" | "tertiary";
+		/**
+		  * The icon element.
+		 */
+		"icon"?: Element;
+		/**
+		  * Should the button only display an icon.
+		 */
+		"iconOnly"?: boolean;
+		/**
+		  * The position of the icon.
+		 */
+		"iconPosition"?: "left" | "right";
+		/**
+		  * The label for the button.
+		 */
+		"label"?: string;
+		/**
+		  * The event fired when the button is clicked.
+		 */
+		"onButtonClick"?: (event: SearchcraftButtonCustomEvent<void>) => void;
+		/**
+		  * The type of the button.
+		 */
+		"type"?: "submit" | "reset" | "button";
+	}
+	/**
+	 * This web component is designed to display a user-friendly error message when a search query fails, providing clear feedback to users and enhancing their experience when an issue arises during the search process.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-error-message error-message="No search results found for query" />
+	 * ```
+	 */
+	interface SearchcraftErrorMessage {
+		/**
+		  * The error message.
+		 */
+		"errorMessage"?: string;
+	}
+	/**
+	 * This web component is designed to display facets in a search interface, allowing users to refine their search results by applying filters based on various attributes.
+	 * It is consumed within the `searchcraft-filter-panel`.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-facet-list field-name="title" />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const facetList = document.querySelector('searchcraft-facet-list');
+	 * facetList.addEventListener('facetSelectionUpdated', () => {
+	 *   console.log('Facet selection updated');
+	 * });
+	 * ```
+	 */
+	interface SearchcraftFacetList {
+		/**
+		  * The name of the field where facets are applied.
+		 */
+		"fieldName"?: string;
+		/**
+		  * When the facets are updated.
+		 */
+		"onFacetSelectionUpdated"?: (event: SearchcraftFacetListCustomEvent<{
+			paths: string[];
+		}>) => void;
+	}
+	/**
+	 * This web component represents a series of filters that allows users to refine and control their search queries by applying various filter criteria.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-filter-panel />
+	 * ```
+	 */
+	interface SearchcraftFilterPanel {
+		/**
+		  * The items to filter.
+		 */
+		"items"?: FilterItem[];
+	}
+	/**
+	 * This web component provides a user-friendly interface for querying an indexed dataset, enabling users to easily search large collections of data.
+	 * It abstracts the complexities of index-based searching, making it accessible to users of all technical levels.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-input-form placeholder-value="Search here" />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const searchInputForm = document.querySelector('searchcraft-input-form');
+	 * ```
+	 */
+	interface SearchcraftInputForm {
+		/**
+		  * Whether or not to automatically submit the search term when the input changes.
+		 */
+		"autoSearch"?: boolean;
+		/**
+		  * The label for the submit button.
+		 */
+		"buttonLabel"?: string;
+		/**
+		  * Where to place the search button.
+		 */
+		"buttonPlacement"?: "left" | "right" | "none";
+		"core"?: SearchcraftCore;
+		/**
+		  * A custom styles object to be applied to the input element.
+		 */
+		"customStyles"?: string | Record<string, string>;
+		/**
+		  * The label rendered above the input.
+		 */
+		"inputLabel"?: string;
+		/**
+		  * When the input becomes unfocused.
+		 */
+		"onInputBlur"?: (event: SearchcraftInputFormCustomEvent<void>) => void;
+		/**
+		  * When the input becomes focused.
+		 */
+		"onInputFocus"?: (event: SearchcraftInputFormCustomEvent<void>) => void;
+		/**
+		  * Event emitted when input initializes.
+		 */
+		"onInputInit"?: (event: SearchcraftInputFormCustomEvent<void>) => void;
+		/**
+		  * 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.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-input-label label="Search" />
+	 * ```
+	 */
+	interface SearchcraftInputLabel {
+		/**
+		  * The classname applied to the label element.
+		 */
+		"inputLabelClassName"?: string | undefined;
+		"label"?: string;
+	}
+	/**
+	 * This web component is designed to facilitate pagination of search results.
+	 * Once a query is submitted, calculates the number for pages.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-pagination />
+	 * ```
+	 */
+	interface SearchcraftPagination {
+		/**
+		  * The custom styles object.
+		 */
+		"customStyles"?: string;
+	}
+	/**
+	 * Renders a button which, when clicked, turns on popover visibility.
+	 */
+	interface SearchcraftPopoverButton {
+	}
+	/**
+	 * 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.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-popover-form type="fullscreen" />
+	 * ```
+	 * ```js
+	 * // index.js
+	 * const popoverForm = document.querySelector('searchcraft-popover-form');
+	 * popoverForm.popoverResultMappings = {
+	 *  containerHref: {
+	 *   fieldNames: [
+	 *    {
+	 *      fieldName: 'canonical_link',
+	 *      dataType: 'text',
+	 *    },
+	 *  ],
+	 *  };
+	 * ```
+	 */
+	interface SearchcraftPopoverForm {
+		/**
+		  * The hotkey that activates the popover.
+		 */
+		"hotkey"?: string;
+		/**
+		  * The hotkey modifier that activates the popover. Used together with the `hotkey` prop.
+		 */
+		"hotkeyModifier"?: "ctrl" | "meta" | "alt" | "option";
+		/**
+		  * Formats the content rendered for each result.
+		 */
+		"popoverResultMappings"?: PopoverResultMappings;
+		/**
+		  * 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.
+		 */
+		"type"?: "inline" | "fullscreen" | "modal";
+	}
+	/**
+	 * A single list item rendered in a searchcraft-popover-list-view.
+	 */
+	interface SearchcraftPopoverListItem {
+		/**
+		  * The document position relative to the search results (For Measure)
+		 */
+		"documentPosition"?: number;
+		"item"?: SearchClientResponseItem | undefined;
+		"popoverResultMappings"?: PopoverResultMappings | undefined;
+	}
+	/**
+	 * This web component is designed to display a list of results within a popover interface.
+	 * It is consumed within the `searchcraft-popover-form` component.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-popover-list-view />
+	 * ```
+	 */
+	interface SearchcraftPopoverListView {
+		"adClientResponseItems"?: AdClientResponseItem[] | undefined;
+		/**
+		  * The mappings that define how the data in the documents are mapped to the list-view-item elements.
+		 */
+		"popoverResultMappings"?: PopoverResultMappings | undefined;
+		/**
+		  * The items to render in the list view.
+		 */
+		"searchClientResponseItems"?: SearchClientResponseItem[] | undefined;
+		"searchResultsPage": number;
+		"searchResultsPerPage": number;
+	}
+	/**
+	 * This web component is designed to display the number of results returned from a search query.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <script>
+	 *  const resultsInfo = document.querySelector('searchcraft-results-info');
+	 *  resultsInfo.customFormatter = (range, count, responseTime) =>
+	 *    `${range[0]}-${range[1]} of ${count} results in ${responseTime}ms`;
+	 * </script>
+	 * <searchcraft-results-info />
+	 * ```
+	 */
+	interface SearchcraftResultsInfo {
+		/**
+		  * The custom formatter for the resulting string.
+		  * @example ```ts  resultsInfo.customFormatter = (range, count, responseTime) =>    `${range[0]}-${range[1]} of ${count} results in ${responseTime}ms`; ```
+		 */
+		"customFormatter"?: (range: [
+			string,
+			string
+		], count: string, responseTime: string) => void;
+		/**
+		  * The custom styles object.
+		 */
+		"customStyles"?: string;
+	}
+	/**
+	 * This web component is designed to choose the number of search results displayed.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-search-results-per-page increment="20" />
+	 * ```
+	 */
+	interface SearchcraftSearchResultsPerPage {
+		/**
+		  * The custom styles object.
+		 */
+		"customStyles"?: string;
+		/**
+		  * 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;
+	}
+	/**
+	 * This web component is designed to allow users to select between a group of options.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-select
+	 *  inputId="searchcraft-select"
+	 *  name="searchcraft-select"
+	 *  options="[{ label: 'label', value: 'value' }]"
+	 * />
+	 * ```
+	 */
+	interface SearchcraftSelect {
+		/**
+		  * The caption displayed below the select input.
+		 */
+		"caption"?: string;
+		/**
+		  * A custom styles object.
+		 */
+		"customStyles"?: string;
+		/**
+		  * Whether the select input is disabled.
+		 */
+		"disabled"?: boolean;
+		/**
+		  * The ID for the select input.
+		 */
+		"inputId": string;
+		/**
+		  * The label of the select input.
+		 */
+		"label"?: string;
+		/**
+		  * The ID for the label of the select input.
+		 */
+		"labelId"?: string;
+		/**
+		  * The name of the select input.
+		 */
+		"name": string;
+		/**
+		  * The event fired when the select is changed.
+		 */
+		"onSelectChange"?: (event: SearchcraftSelectCustomEvent<string>) => void;
+		/**
+		  * The options for the select input.
+		 */
+		"options"?: SearchcraftSelectOption[] | string;
+	}
+	/**
+	 * 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.
+	 * It is consumed by the `searchcraft-filter-panel` component.
+	 */
+	interface SearchcraftSlider {
+		/**
+		  * The type of data allowed.
+		 */
+		"dataType"?: "number" | "date";
+		/**
+		  * The granularity that the value must adhere to.
+		 */
+		"granularity"?: number;
+		/**
+		  * The maximum value allowed.
+		 */
+		"max"?: number;
+		/**
+		  * The minimum value allowed.
+		 */
+		"min"?: number;
+		/**
+		  * When the range has changed.
+		 */
+		"onRangeChanged"?: (event: SearchcraftSliderCustomEvent<any>) => void;
+	}
+	/**
+	 * This web component adds Searchcraft's built-in css theme to your page's <head> tag.
+	 * It does not render anything visible, its only function is to manage the css styles on the page.
+	 * ## Usage
+	 * ```html
+	 * <!-- index.html -->
+	 * <searchcraft-theme theme="light" custom-theme="{}" />
+	 * ```
+	 */
+	interface SearchcraftTheme {
+		/**
+		  * The custom theme configuration object.
+		 */
+		"customTheme"?: string;
+		/**
+		  * The name of the theme.
+		 */
+		"theme"?: string;
+	}
+	/**
+	 * This web component simulates a light switch functionality, providing a simple and intuitive toggle between two states—on and off.
+	 * It is consumed within the `searchcraft-filter-panel` component.
+	 */
+	interface SearchcraftToggleButton {
+		/**
+		  * The label.
+		 */
+		"label"?: string;
+		/**
+		  * When the toggle element is changed.
+		 */
+		"onToggleUpdated"?: (event: SearchcraftToggleButtonCustomEvent<boolean>) => void;
+		/**
+		  * The secondary label displayed below the main label.
+		 */
+		"subLabel"?: string | undefined;
+	}
+	interface IntrinsicElements {
+		"searchcraft-ad": SearchcraftAd;
+		"searchcraft-base-search-result": SearchcraftBaseSearchResult;
+		"searchcraft-base-search-results": SearchcraftBaseSearchResults;
+		"searchcraft-button": SearchcraftButton;
+		"searchcraft-error-message": SearchcraftErrorMessage;
+		"searchcraft-facet-list": SearchcraftFacetList;
+		"searchcraft-filter-panel": SearchcraftFilterPanel;
+		"searchcraft-input-form": SearchcraftInputForm;
+		"searchcraft-input-label": SearchcraftInputLabel;
+		"searchcraft-pagination": SearchcraftPagination;
+		"searchcraft-popover-button": SearchcraftPopoverButton;
+		"searchcraft-popover-form": SearchcraftPopoverForm;
+		"searchcraft-popover-list-item": SearchcraftPopoverListItem;
+		"searchcraft-popover-list-view": SearchcraftPopoverListView;
+		"searchcraft-results-info": SearchcraftResultsInfo;
+		"searchcraft-search-results-per-page": SearchcraftSearchResultsPerPage;
+		"searchcraft-select": SearchcraftSelect;
+		"searchcraft-slider": SearchcraftSlider;
+		"searchcraft-theme": SearchcraftTheme;
+		"searchcraft-toggle-button": SearchcraftToggleButton;
+	}
+}
+declare module "@stencil/core" {
+	export namespace JSX {
+		interface IntrinsicElements {
+			/**
+			 * An inline ad meant to be rendered in a list of search results.
+			 */
+			"searchcraft-ad": LocalJSX.SearchcraftAd & JSXBase.HTMLAttributes<HTMLSearchcraftAdElement>;
+			/**
+			 * This web component is designed to display detailed information for a single search result.
+			 * Once a query is submitted, the component formats and presents the result.
+			 * It is consumed within the `searchcraft-base-search-results` component.
+			 */
+			"searchcraft-base-search-result": LocalJSX.SearchcraftBaseSearchResult & JSXBase.HTMLAttributes<HTMLSearchcraftBaseSearchResultElement>;
+			/**
+			 * This web component is responsible for displaying the results of a search query.
+			 * Once a query is submitted, the component formats and presents an ordered list of the results.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-base-search-results
+			 *   ad-interval="4"
+			 *   place-ad-at-start="false"
+			 *   result-image-placement="right"
+			 * />
+			 * ```
+			 * ```js
+			 * // index.js
+			 * const baseSearchResults = document.querySelector('searchcraft-base-search-results');
+			 * baseSearchResults.searchResultMappings = containerHref: {
+			 *   fieldNames: [
+			 *    {
+			 *      fieldName: 'canonical_link',
+			 *      dataType: 'text',
+			 *    },
+			 *  ],
+			 * };
+			 * baseSearchResults.addEventListener('noResults', () => {
+			 *   console.log('No search results found');
+			 * });
+			 * ```
+			 */
+			"searchcraft-base-search-results": LocalJSX.SearchcraftBaseSearchResults & JSXBase.HTMLAttributes<HTMLSearchcraftBaseSearchResultsElement>;
+			/**
+			 * This web component represents a button to be consumed within the `search-input-form` component.
+			 * It provides a clear, interactive way for users to submit search queries or trigger actions in a search interface.
+			 * It is consumed within the `searchcraft-input-form` component.
+			 */
+			"searchcraft-button": LocalJSX.SearchcraftButton & JSXBase.HTMLAttributes<HTMLSearchcraftButtonElement>;
+			/**
+			 * This web component is designed to display a user-friendly error message when a search query fails, providing clear feedback to users and enhancing their experience when an issue arises during the search process.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-error-message error-message="No search results found for query" />
+			 * ```
+			 */
+			"searchcraft-error-message": LocalJSX.SearchcraftErrorMessage & JSXBase.HTMLAttributes<HTMLSearchcraftErrorMessageElement>;
+			/**
+			 * This web component is designed to display facets in a search interface, allowing users to refine their search results by applying filters based on various attributes.
+			 * It is consumed within the `searchcraft-filter-panel`.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-facet-list field-name="title" />
+			 * ```
+			 * ```js
+			 * // index.js
+			 * const facetList = document.querySelector('searchcraft-facet-list');
+			 * facetList.addEventListener('facetSelectionUpdated', () => {
+			 *   console.log('Facet selection updated');
+			 * });
+			 * ```
+			 */
+			"searchcraft-facet-list": LocalJSX.SearchcraftFacetList & JSXBase.HTMLAttributes<HTMLSearchcraftFacetListElement>;
+			/**
+			 * This web component represents a series of filters that allows users to refine and control their search queries by applying various filter criteria.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-filter-panel />
+			 * ```
+			 */
+			"searchcraft-filter-panel": LocalJSX.SearchcraftFilterPanel & JSXBase.HTMLAttributes<HTMLSearchcraftFilterPanelElement>;
+			/**
+			 * This web component provides a user-friendly interface for querying an indexed dataset, enabling users to easily search large collections of data.
+			 * It abstracts the complexities of index-based searching, making it accessible to users of all technical levels.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-input-form placeholder-value="Search here" />
+			 * ```
+			 * ```js
+			 * // index.js
+			 * const searchInputForm = document.querySelector('searchcraft-input-form');
+			 * ```
+			 */
+			"searchcraft-input-form": LocalJSX.SearchcraftInputForm & JSXBase.HTMLAttributes<HTMLSearchcraftInputFormElement>;
+			/**
+			 * This web component serves as the input label for the searchcraft-input-form component.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-input-label label="Search" />
+			 * ```
+			 */
+			"searchcraft-input-label": LocalJSX.SearchcraftInputLabel & JSXBase.HTMLAttributes<HTMLSearchcraftInputLabelElement>;
+			/**
+			 * This web component is designed to facilitate pagination of search results.
+			 * Once a query is submitted, calculates the number for pages.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-pagination />
+			 * ```
+			 */
+			"searchcraft-pagination": LocalJSX.SearchcraftPagination & JSXBase.HTMLAttributes<HTMLSearchcraftPaginationElement>;
+			/**
+			 * Renders a button which, when clicked, turns on popover visibility.
+			 */
+			"searchcraft-popover-button": LocalJSX.SearchcraftPopoverButton & JSXBase.HTMLAttributes<HTMLSearchcraftPopoverButtonElement>;
+			/**
+			 * 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.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-popover-form type="fullscreen" />
+			 * ```
+			 * ```js
+			 * // index.js
+			 * const popoverForm = document.querySelector('searchcraft-popover-form');
+			 * popoverForm.popoverResultMappings = {
+			 *  containerHref: {
+			 *   fieldNames: [
+			 *    {
+			 *      fieldName: 'canonical_link',
+			 *      dataType: 'text',
+			 *    },
+			 *  ],
+			 *  };
+			 * ```
+			 */
+			"searchcraft-popover-form": LocalJSX.SearchcraftPopoverForm & JSXBase.HTMLAttributes<HTMLSearchcraftPopoverFormElement>;
+			/**
+			 * A single list item rendered in a searchcraft-popover-list-view.
+			 */
+			"searchcraft-popover-list-item": LocalJSX.SearchcraftPopoverListItem & JSXBase.HTMLAttributes<HTMLSearchcraftPopoverListItemElement>;
+			/**
+			 * This web component is designed to display a list of results within a popover interface.
+			 * It is consumed within the `searchcraft-popover-form` component.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-popover-list-view />
+			 * ```
+			 */
+			"searchcraft-popover-list-view": LocalJSX.SearchcraftPopoverListView & JSXBase.HTMLAttributes<HTMLSearchcraftPopoverListViewElement>;
+			/**
+			 * This web component is designed to display the number of results returned from a search query.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <script>
+			 *  const resultsInfo = document.querySelector('searchcraft-results-info');
+			 *  resultsInfo.customFormatter = (range, count, responseTime) =>
+			 *    `${range[0]}-${range[1]} of ${count} results in ${responseTime}ms`;
+			 * </script>
+			 * <searchcraft-results-info />
+			 * ```
+			 */
+			"searchcraft-results-info": LocalJSX.SearchcraftResultsInfo & JSXBase.HTMLAttributes<HTMLSearchcraftResultsInfoElement>;
+			/**
+			 * This web component is designed to choose the number of search results displayed.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-search-results-per-page increment="20" />
+			 * ```
+			 */
+			"searchcraft-search-results-per-page": LocalJSX.SearchcraftSearchResultsPerPage & JSXBase.HTMLAttributes<HTMLSearchcraftSearchResultsPerPageElement>;
+			/**
+			 * This web component is designed to allow users to select between a group of options.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-select
+			 *  inputId="searchcraft-select"
+			 *  name="searchcraft-select"
+			 *  options="[{ label: 'label', value: 'value' }]"
+			 * />
+			 * ```
+			 */
+			"searchcraft-select": LocalJSX.SearchcraftSelect & JSXBase.HTMLAttributes<HTMLSearchcraftSelectElement>;
+			/**
+			 * 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.
+			 * It is consumed by the `searchcraft-filter-panel` component.
+			 */
+			"searchcraft-slider": LocalJSX.SearchcraftSlider & JSXBase.HTMLAttributes<HTMLSearchcraftSliderElement>;
+			/**
+			 * This web component adds Searchcraft's built-in css theme to your page's <head> tag.
+			 * It does not render anything visible, its only function is to manage the css styles on the page.
+			 * ## Usage
+			 * ```html
+			 * <!-- index.html -->
+			 * <searchcraft-theme theme="light" custom-theme="{}" />
+			 * ```
+			 */
+			"searchcraft-theme": LocalJSX.SearchcraftTheme & JSXBase.HTMLAttributes<HTMLSearchcraftThemeElement>;
+			/**
+			 * This web component simulates a light switch functionality, providing a simple and intuitive toggle between two states—on and off.
+			 * It is consumed within the `searchcraft-filter-panel` component.
+			 */
+			"searchcraft-toggle-button": LocalJSX.SearchcraftToggleButton & JSXBase.HTMLAttributes<HTMLSearchcraftToggleButtonElement>;
+		}
+	}
+}
+/**
+ * The consumer-facing `Searchcraft` class.
+ */
+export declare class Searchcraft extends SearchcraftCore {
+	constructor(config: SearchcraftConfig);
+}
+
+export {
+	LocalJSX as JSX,
+};
+
+export {};