@searchcraft/vue-sdk 0.12.2 → 0.13.1

package/dist/index.d.ts

@@ -582,8 +582,9 @@ declare class MeasureClient {
 	private config;
 	private sdkInfo;
 	private userId;
+	private userType;
 	sessionId: string;
-	constructor(config: SearchcraftConfig, sdkInfo: SearchcraftSDKInfo, userId: string);
+	constructor(config: SearchcraftConfig, sdkInfo: SearchcraftSDKInfo, userId: string, userType: "authenticated" | "anonymous");
 	/**
 	 * Getter for the base url used by the /measure endpoints.
 	 */
@@ -654,6 +655,7 @@ export interface SearchcraftStateFunctions {
 	search: (options?: {
 		skipSummary?: boolean;
 	}) => Promise<void>;
+	setFilterPanelVisibility: (isVisible: boolean) => void;
 	setPopoverVisibility: (isVisible: boolean) => void;
 	setSearchResultsCount: (count: number) => void;
 	setSearchResultsPage: (page: number) => void;
@@ -676,6 +678,7 @@ export interface SearchcraftStateValues {
 	hotkey: string;
 	hotkeyModifier: "ctrl" | "meta" | "alt" | "option";
 	facetPathsForIndexFields: Record<string, FacetPathsForIndexField>;
+	isFilterPanelVisible: boolean;
 	isPopoverVisible: boolean;
 	isSearchInProgress: boolean;
 	rangeValueForIndexFields: Record<string, RangeValueForIndexField>;
@@ -717,6 +720,7 @@ export declare class SearchcraftCore {
 	searchClient: SearchClient | undefined;
 	adClient: AdClient | undefined;
 	userId: string;
+	userType: "authenticated" | "anonymous";
 	private requestTimeout;
 	private subscriptionEvents;
 	/**
@@ -764,9 +768,13 @@ export namespace Components {
 	 */
 	interface SearchcraftAd {
 		"adClientResponseItem"?: AdClientResponseItem;
+		/**
+		  * @default 'Custom'
+		 */
 		"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.
+		  * @default 'interstitial'
 		 */
 		"renderPosition": "interstitial" | "top" | "bottom";
 		/**
@@ -781,10 +789,12 @@ export namespace Components {
 	interface SearchcraftButton {
 		/**
 		  * Whether the button is disabled.
+		  * @default false
 		 */
 		"disabled"?: boolean;
 		/**
 		  * Controls the visual representation of the button.
+		  * @default 'primary'
 		 */
 		"hierarchy"?: "primary" | "tertiary";
 		/**
@@ -793,18 +803,22 @@ export namespace Components {
 		"icon"?: Element;
 		/**
 		  * Should the button only display an icon.
+		  * @default false
 		 */
 		"iconOnly"?: boolean;
 		/**
 		  * The position of the icon.
+		  * @default 'left'
 		 */
 		"iconPosition"?: "left" | "right";
 		/**
 		  * The label for the button.
+		  * @default 'Search'
 		 */
 		"label": string;
 		/**
 		  * The type of the button.
+		  * @default 'button'
 		 */
 		"type"?: "submit" | "reset" | "button";
 	}
@@ -840,6 +854,7 @@ export namespace Components {
 		"exclude"?: string[];
 		/**
 		  * The name of the field where facets are applied.
+		  * @default ''
 		 */
 		"fieldName": string;
 		/**
@@ -876,8 +891,19 @@ export namespace Components {
 	interface SearchcraftFilterPanel {
 		/**
 		  * The items to filter.
+		  * @default []
 		 */
 		"items": FilterItem[];
+		/**
+		  * Controls whether the filter panel automatically hides/shows based on window size. - 'auto': Automatically hide/show based on window width - 'manual': User controls visibility manually
+		  * @default 'auto'
+		 */
+		"responsiveBehavior"?: "auto" | "manual";
+		/**
+		  * The breakpoint (in pixels) below which the filter panel will be hidden. Defaults to 768px (--sc-breakpoint-md).
+		  * @default 768
+		 */
+		"responsiveBreakpoint"?: number;
 		/**
 		  * The id of the Searchcraft instance that this component should use.
 		 */
@@ -905,6 +931,7 @@ export namespace Components {
 	interface SearchcraftInputForm {
 		/**
 		  * Whether or not to automatically submit the search term when the input changes.
+		  * @default true
 		 */
 		"autoSearch"?: boolean;
 		/**
@@ -913,6 +940,7 @@ export namespace Components {
 		"buttonLabel"?: string;
 		/**
 		  * Where to place the search button.
+		  * @default 'none'
 		 */
 		"buttonPlacement"?: "left" | "right" | "none";
 		/**
@@ -925,6 +953,7 @@ export namespace Components {
 		"placeholderBehavior"?: "hide-on-focus" | "hide-on-text-entered";
 		/**
 		  * The input element's placeholder value.
+		  * @default 'Enter Search'
 		 */
 		"placeholderValue"?: string;
 		/**
@@ -945,8 +974,12 @@ export namespace Components {
 	interface SearchcraftInputLabel {
 		/**
 		  * The classname applied to the label element.
+		  * @default ''
 		 */
 		"inputLabelClassName"?: string | undefined;
+		/**
+		  * @default ''
+		 */
 		"label": string;
 	}
 	/**
@@ -1069,10 +1102,12 @@ export namespace Components {
 	interface SearchcraftPopoverForm {
 		/**
 		  * The hotkey that activates the popover.
+		  * @default 'k'
 		 */
 		"hotkey"?: string;
 		/**
 		  * The hotkey modifier that activates the popover. Used together with the `hotkey` prop.
+		  * @default 'meta'
 		 */
 		"hotkeyModifier"?: "ctrl" | "meta" | "alt" | "option";
 		/**
@@ -1081,6 +1116,7 @@ export namespace Components {
 		"placeholderBehavior"?: "hide-on-focus" | "hide-on-text-entered";
 		/**
 		  * The input element's placeholder value.
+		  * @default 'Enter Search'
 		 */
 		"placeholderValue"?: string;
 		/**
@@ -1093,6 +1129,7 @@ export namespace Components {
 		"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.
+		  * @default 'inline'
 		 */
 		"type"?: "inline" | "fullscreen" | "modal";
 	}
@@ -1102,6 +1139,7 @@ export namespace Components {
 	interface SearchcraftPopoverListItem {
 		/**
 		  * The document position relative to the search results (For Measure)
+		  * @default 0
 		 */
 		"documentPosition": number;
 		"item": SearchClientResponseItem | undefined;
@@ -1185,6 +1223,7 @@ export namespace Components {
 	interface SearchcraftSearchResult {
 		/**
 		  * The position in the document. Used with the "document_clicked" measure event.
+		  * @default 0
 		 */
 		"documentPosition": number;
 		/**
@@ -1278,6 +1317,7 @@ export namespace Components {
 	interface SearchcraftSearchResultsPerPage {
 		/**
 		  * 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.
+		  * @default 20
 		 */
 		"increment": string | number;
 		/**
@@ -1303,6 +1343,7 @@ export namespace Components {
 		"caption"?: string;
 		/**
 		  * Whether the select input is disabled.
+		  * @default false
 		 */
 		"disabled"?: boolean;
 		/**
@@ -1323,6 +1364,7 @@ export namespace Components {
 		"name": string;
 		/**
 		  * The options for the select input.
+		  * @default []
 		 */
 		"options": SearchcraftSelectOption[] | string;
 	}
@@ -1332,6 +1374,7 @@ export namespace Components {
 	interface SearchcraftSlider {
 		/**
 		  * The type of data the sliders are using.
+		  * @default 'number'
 		 */
 		"dataType": "number" | "date";
 		/**
@@ -1340,14 +1383,17 @@ export namespace Components {
 		"dateGranularity"?: "year" | "month" | "day" | "hour";
 		/**
 		  * The maximum value allowed.
+		  * @default 100
 		 */
 		"max": number;
 		/**
 		  * The minimum value allowed.
+		  * @default 0
 		 */
 		"min": number;
 		/**
 		  * The step amount for the slider inputs.
+		  * @default 1
 		 */
 		"step": number;
 	}
@@ -1404,6 +1450,7 @@ export namespace Components {
 	interface SearchcraftToggleButton {
 		/**
 		  * The label.
+		  * @default 'Toggle'
 		 */
 		"label": string;
 		/**
@@ -2013,9 +2060,13 @@ declare namespace LocalJSX {
 	 */
 	interface SearchcraftAd {
 		"adClientResponseItem"?: AdClientResponseItem;
+		/**
+		  * @default 'Custom'
+		 */
 		"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.
+		  * @default 'interstitial'
 		 */
 		"renderPosition"?: "interstitial" | "top" | "bottom";
 		/**
@@ -2030,10 +2081,12 @@ declare namespace LocalJSX {
 	interface SearchcraftButton {
 		/**
 		  * Whether the button is disabled.
+		  * @default false
 		 */
 		"disabled"?: boolean;
 		/**
 		  * Controls the visual representation of the button.
+		  * @default 'primary'
 		 */
 		"hierarchy"?: "primary" | "tertiary";
 		/**
@@ -2042,14 +2095,17 @@ declare namespace LocalJSX {
 		"icon"?: Element;
 		/**
 		  * Should the button only display an icon.
+		  * @default false
 		 */
 		"iconOnly"?: boolean;
 		/**
 		  * The position of the icon.
+		  * @default 'left'
 		 */
 		"iconPosition"?: "left" | "right";
 		/**
 		  * The label for the button.
+		  * @default 'Search'
 		 */
 		"label"?: string;
 		/**
@@ -2058,6 +2114,7 @@ declare namespace LocalJSX {
 		"onButtonClick"?: (event: SearchcraftButtonCustomEvent<void>) => void;
 		/**
 		  * The type of the button.
+		  * @default 'button'
 		 */
 		"type"?: "submit" | "reset" | "button";
 	}
@@ -2093,6 +2150,7 @@ declare namespace LocalJSX {
 		"exclude"?: string[];
 		/**
 		  * The name of the field where facets are applied.
+		  * @default ''
 		 */
 		"fieldName"?: string;
 		/**
@@ -2135,8 +2193,19 @@ declare namespace LocalJSX {
 	interface SearchcraftFilterPanel {
 		/**
 		  * The items to filter.
+		  * @default []
 		 */
 		"items"?: FilterItem[];
+		/**
+		  * Controls whether the filter panel automatically hides/shows based on window size. - 'auto': Automatically hide/show based on window width - 'manual': User controls visibility manually
+		  * @default 'auto'
+		 */
+		"responsiveBehavior"?: "auto" | "manual";
+		/**
+		  * The breakpoint (in pixels) below which the filter panel will be hidden. Defaults to 768px (--sc-breakpoint-md).
+		  * @default 768
+		 */
+		"responsiveBreakpoint"?: number;
 		/**
 		  * The id of the Searchcraft instance that this component should use.
 		 */
@@ -2164,6 +2233,7 @@ declare namespace LocalJSX {
 	interface SearchcraftInputForm {
 		/**
 		  * Whether or not to automatically submit the search term when the input changes.
+		  * @default true
 		 */
 		"autoSearch"?: boolean;
 		/**
@@ -2172,6 +2242,7 @@ declare namespace LocalJSX {
 		"buttonLabel"?: string;
 		/**
 		  * Where to place the search button.
+		  * @default 'none'
 		 */
 		"buttonPlacement"?: "left" | "right" | "none";
 		/**
@@ -2196,6 +2267,7 @@ declare namespace LocalJSX {
 		"placeholderBehavior"?: "hide-on-focus" | "hide-on-text-entered";
 		/**
 		  * The input element's placeholder value.
+		  * @default 'Enter Search'
 		 */
 		"placeholderValue"?: string;
 		/**
@@ -2216,8 +2288,12 @@ declare namespace LocalJSX {
 	interface SearchcraftInputLabel {
 		/**
 		  * The classname applied to the label element.
+		  * @default ''
 		 */
 		"inputLabelClassName"?: string | undefined;
+		/**
+		  * @default ''
+		 */
 		"label"?: string;
 	}
 	/**
@@ -2340,10 +2416,12 @@ declare namespace LocalJSX {
 	interface SearchcraftPopoverForm {
 		/**
 		  * The hotkey that activates the popover.
+		  * @default 'k'
 		 */
 		"hotkey"?: string;
 		/**
 		  * The hotkey modifier that activates the popover. Used together with the `hotkey` prop.
+		  * @default 'meta'
 		 */
 		"hotkeyModifier"?: "ctrl" | "meta" | "alt" | "option";
 		/**
@@ -2352,6 +2430,7 @@ declare namespace LocalJSX {
 		"placeholderBehavior"?: "hide-on-focus" | "hide-on-text-entered";
 		/**
 		  * The input element's placeholder value.
+		  * @default 'Enter Search'
 		 */
 		"placeholderValue"?: string;
 		/**
@@ -2364,6 +2443,7 @@ declare namespace LocalJSX {
 		"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.
+		  * @default 'inline'
 		 */
 		"type"?: "inline" | "fullscreen" | "modal";
 	}
@@ -2373,6 +2453,7 @@ declare namespace LocalJSX {
 	interface SearchcraftPopoverListItem {
 		/**
 		  * The document position relative to the search results (For Measure)
+		  * @default 0
 		 */
 		"documentPosition"?: number;
 		"item"?: SearchClientResponseItem | undefined;
@@ -2456,6 +2537,7 @@ declare namespace LocalJSX {
 	interface SearchcraftSearchResult {
 		/**
 		  * The position in the document. Used with the "document_clicked" measure event.
+		  * @default 0
 		 */
 		"documentPosition"?: number;
 		/**
@@ -2549,6 +2631,7 @@ declare namespace LocalJSX {
 	interface SearchcraftSearchResultsPerPage {
 		/**
 		  * 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.
+		  * @default 20
 		 */
 		"increment"?: string | number;
 		/**
@@ -2574,6 +2657,7 @@ declare namespace LocalJSX {
 		"caption"?: string;
 		/**
 		  * Whether the select input is disabled.
+		  * @default false
 		 */
 		"disabled"?: boolean;
 		/**
@@ -2598,6 +2682,7 @@ declare namespace LocalJSX {
 		"onSelectChange"?: (event: SearchcraftSelectCustomEvent<string>) => void;
 		/**
 		  * The options for the select input.
+		  * @default []
 		 */
 		"options"?: SearchcraftSelectOption[] | string;
 	}
@@ -2607,6 +2692,7 @@ declare namespace LocalJSX {
 	interface SearchcraftSlider {
 		/**
 		  * The type of data the sliders are using.
+		  * @default 'number'
 		 */
 		"dataType"?: "number" | "date";
 		/**
@@ -2615,10 +2701,12 @@ declare namespace LocalJSX {
 		"dateGranularity"?: "year" | "month" | "day" | "hour";
 		/**
 		  * The maximum value allowed.
+		  * @default 100
 		 */
 		"max"?: number;
 		/**
 		  * The minimum value allowed.
+		  * @default 0
 		 */
 		"min"?: number;
 		/**
@@ -2627,6 +2715,7 @@ declare namespace LocalJSX {
 		"onRangeChanged"?: (event: SearchcraftSliderCustomEvent<any>) => void;
 		/**
 		  * The step amount for the slider inputs.
+		  * @default 1
 		 */
 		"step"?: number;
 	}
@@ -2683,6 +2772,7 @@ declare namespace LocalJSX {
 	interface SearchcraftToggleButton {
 		/**
 		  * The label.
+		  * @default 'Toggle'
 		 */
 		"label"?: string;
 		/**