@searchstax-inc/searchstudio-ux-js 4.2.2 → 4.2.13

package/dist/@searchstax-inc/searchstudio-ux-js.d.mts

@@ -1,35 +1,5 @@
 // Generated by dts-bundle-generator v7.2.0
 
-export interface IFacet {
-	name: string;
-	label: string;
-	values: (IFacetValue | IFacetValueRange)[];
-}
-export interface IFacetValue {
-	value: string;
-	type: "checkbox";
-	parentName: string;
-	count: number;
-}
-export interface IFacetValueRange {
-	valueFrom: string;
-	type: "range";
-	valueTo: string;
-	parentName: string;
-	count: number;
-}
-export interface IFacetData extends IFacet {
-	values: (IFacetValue | IFacetValueRange)[];
-	showingAllFacets?: boolean;
-	hasMoreFacets?: boolean;
-}
-export interface IFacetsTemplateData extends ISearchstaxParsedData {
-	facets: IFacetData[];
-	isMobile?: boolean;
-}
-export interface IFacetValueData extends IFacetValue {
-	disabled?: boolean;
-}
 export interface ISearchstaxParam {
 	q: string;
 	fl: string;
@@ -269,7 +239,6 @@ export interface ISearchstaxParsedData {
 	searchTerm: string;
 	autoCorrectedQuery: string;
 	originalQuery: string;
-	selectedFacets: (IFacetValue | IFacetValueRange)[];
 	relatedSearches: ISearchstaxRelatedSearchResult[];
 	externalPromotions: IExternalPromotion[];
 	answer: string;
@@ -399,6 +368,36 @@ export declare const enum ISearchstaxRenderEngine {
 	"react" = 2,
 	"angular" = 3
 }
+export interface IFacet {
+	name: string;
+	label: string;
+	values: (IFacetValue | IFacetValueRange)[];
+}
+export interface IFacetValue {
+	value: string;
+	type: "checkbox";
+	parentName: string;
+	count: number;
+}
+export interface IFacetValueRange {
+	valueFrom: string;
+	type: "range";
+	valueTo: string;
+	parentName: string;
+	count: number;
+}
+export interface IFacetData extends IFacet {
+	values: (IFacetValue | IFacetValueRange)[];
+	showingAllFacets?: boolean;
+	hasMoreFacets?: boolean;
+}
+export interface IFacetsTemplateData extends ISearchstaxParsedData {
+	facets: IFacetData[];
+	isMobile?: boolean;
+}
+export interface IFacetValueData extends IFacetValue {
+	disabled?: boolean;
+}
 export interface IPaginationData extends ISearchstaxParsedData {
 	nextPageLink: string;
 	previousPageLink: string;
@@ -460,6 +459,7 @@ export interface ISearchstaxSearchInputAutosuggestTemplateData {
 }
 export interface ISearchstaxSearchInputRenderData extends ISearchstaxParsedData {
 	locationEnabled: boolean;
+	hasInputValue: boolean;
 }
 export interface ISearchstaxLocationConfig {
 	templates?: ISearchstaxLocationConfigTemplates;
@@ -522,8 +522,6 @@ declare class DataCalculations {
 	get isInfiniteScroll(): boolean;
 	get answerErrorMessage(): string;
 	get searchExecuted(): boolean;
-	get selectedFacets(): (IFacetValue | IFacetValueRange)[];
-	get cachedANDFacets(): string;
 	get relatedSearches(): ISearchstaxRelatedSearchResult[];
 	get externalPromotions(): IExternalPromotion[];
 	get data(): ISearchstaxParsedData;
@@ -557,7 +555,11 @@ declare class Observable {
 }
 declare class SearchstaxSearchHelper {
 	cachedQuery: string;
+	cachedQueryOR: string;
+	cachedQueryTabs: string;
 	cachedANDFacets: string;
+	cachedORFacets: string;
+	cachedTabsFacets: string;
 	url: string;
 	relatedSearches: string;
 	suggester: string;
@@ -578,9 +580,9 @@ declare class SearchstaxSearchHelper {
 	generateFacetQuery(facets: ISearchstaxSearcObjectFacet[], isOrFaceting: boolean): string;
 	generateLocationQuery(location: ISearchstaxLocation): string;
 	getRelatedSearches(searchObject: ISearchObject, relatedSearchesUrl: string, relatedSearchesAPIKey: string, callback: (resp: ISearchstaxRelatedSearchesResponse) => void): void;
-	cacheFacets(isTabs?: boolean): Promise<void>;
+	cacheFacets(facetingType?: "and" | "or" | "showUnavailable" | "tabs", initalCacheTypes?: ("and" | "or" | "showUnavailable" | "tabs")[]): Promise<void>;
 	private cacheFacetsCallback;
-	search(searchObject: ISearchObject, callback: (resp: ISearchstaxSearchResponse, isTabs: boolean) => void, ignoreCancelation?: boolean, forceNotCorrected?: boolean, isTabs?: boolean): void;
+	search(searchObject: ISearchObject, callback: (resp?: ISearchstaxSearchResponse, facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void, ignoreCancelation?: boolean, forceNotCorrected?: boolean, facetingType?: "and" | "or" | "showUnavailable" | "tabs"): void;
 	generateQueryParams(searchObject: ISearchObject, forceNotCorrected?: boolean): string;
 	startSSE(query: string, callback: (resp: string) => void): EventSource | void;
 	suggest(term: string, callback: (resp: ISearchstaxSuggestResponse) => void, queryParams: IAdditionalProp[]): void;
@@ -600,8 +602,9 @@ declare class DataLAyer {
 	$searchResultsMetadata: Observable;
 	$searchAutosuggest: Observable;
 	$searchFacets: Observable;
-	$searchFacetsCached: Observable;
-	$searchFacetsCachedTabs: Observable;
+	$searchFacetsCachedand: Observable;
+	$searchFacetsCachedor: Observable;
+	$searchFacetsCachedtabs: Observable;
 	$searchstaxConfig: Observable;
 	$autosuggestResults: Observable;
 	$itemsPerPage: Observable;
@@ -664,7 +667,8 @@ declare class DataLAyer {
 	setSearchObject(value: ISearchObject): void;
 	setSearchFacets(value: IFacet[]): void;
 	setSearchFacetsCached(value: IFacet[]): void;
-	setSearchFacetsCachedTabs(value: IFacet[]): void;
+	setSearchFacetsCachedor(value: IFacet[]): void;
+	setSearchFacetsCachedtabs(value: IFacet[]): void;
 	setSearchRelatedSearches(value: ISearchstaxRelatedSearchResult[]): void;
 	setSearchExternalPromotions(value: IExternalPromotion[]): void;
 	setLanguage(value: string): void;
@@ -701,8 +705,9 @@ declare class DataLAyer {
 	get getAnswerData(): any;
 	get searchstaxConfig(): ISearchstaxConfig | null;
 	get searchFacets(): IFacet[] | null;
-	get searchFacetsCached(): IFacet[] | null;
-	get searchFacetsCachedTabs(): IFacet[] | null;
+	get searchFacetsCachedand(): IFacet[] | null;
+	get searchFacetsCachedtabs(): IFacet[] | null;
+	get searchFacetsCachedor(): IFacet[] | null;
 	get searchResults(): ISearchstaxParsedResult[] | null;
 	get searchTerm(): string;
 	get searchLocation(): string;
@@ -942,7 +947,6 @@ declare class SearchFacetsWidget {
 	routerHelper: RouterHelper;
 	cachedPhrase: string;
 	cachedANDFacets: string;
-	isCached: boolean;
 	overlayOpened: boolean;
 	facetPaginationStep: number;
 	facetPaginationStepMobile: number;
@@ -960,14 +964,13 @@ declare class SearchFacetsWidget {
 	};
 	focusedElement: HTMLInputElement | HTMLElement | null;
 	cachedData: IFacetsTemplateData | null;
-	cacheFacets: (isTabs?: boolean) => void;
+	cacheFacets: (facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void;
 	constructor(params: {
 		containerId: string;
 		config: ISearchstaxSearchFacetsConfig;
 		dataLayer: DataLAyer;
 		routerHelper: RouterHelper;
-	}, cacheFacets: (isTabs?: boolean) => void);
-	get needCache(): boolean;
+	}, cacheFacets: (facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void);
 	get needDisabling(): boolean;
 	private initializeSubscriptions;
 	extractFacetValue(data: IFacetValueData): ISearchstaxSearcObjectFacet;
@@ -987,6 +990,7 @@ declare class SearchFacetsWidget {
 	attachOnclickToShowMore(data: IFacetData, container: Element, isMobile?: boolean): void;
 	onShowMoreLessClick(e: Event, data: IFacetData, isMobile?: boolean): void;
 	private renderMainTemplate;
+	private get componentFacets();
 	generateSelectedFacetsData(): void;
 	createSelectedFacetsComponents(container: Element): void;
 	createClearFacetsComponents(container: Element): void;
@@ -1068,9 +1072,12 @@ declare class SearchInputWidget {
 	private containerId;
 	private currentInputValue;
 	autosuggestResults?: ISearchstaxSEARCHTERM;
+	private suppressNextEnter;
 	private searchInput?;
 	private actionButton?;
 	private autosuggestContainer?;
+	private clearButton?;
+	private separatorIcon?;
 	private buttonState;
 	private selectedAutosuggestItem;
 	private suggestTrigger;
@@ -1086,6 +1093,7 @@ declare class SearchInputWidget {
 	private createAutosuggestContainer;
 	private getSuggestAfterValue;
 	private actionButtonInit;
+	private updateClearButtonVisibility;
 	private attachSubscriptions;
 	private handleLoadingChange;
 	private handleSearchTermChange;
@@ -1093,6 +1101,7 @@ declare class SearchInputWidget {
 	selectPreviousAutosuggestItem(input: HTMLInputElement): void;
 	selectNextAutosuggestItem(): void;
 	resetAutosuggestSelection(): void;
+	clearInput(): void;
 	markActiveAutosuggestItem(): void;
 	private inputKeyupEvent;
 	private autosuggestHandling;
@@ -1158,6 +1167,7 @@ declare class AnswersWidget {
 	renderFeedbackWidget: boolean;
 	clicked: boolean;
 	renderedWithShowMore: boolean;
+	private showMoreListenerAttached;
 	constructor(params: {
 		containerId: string;
 		config: ISearchstaxAnswerConfig;
@@ -1167,7 +1177,7 @@ declare class AnswersWidget {
 	searchstaxFeedbackTextAreaOverride(): string;
 	initializeWidget(): void;
 	showMore(e: Event): void;
-	private attachClickEventToShowMore;
+	private attachShowMoreClickListener;
 	trackLinkClick(e: Event): void;
 	attachLinkTracking(): void;
 	private renderMainTemplate;
@@ -1213,7 +1223,7 @@ export declare class Searchstax {
 	searchInputWidget?: SearchInputWidget;
 	searchLocationWidget?: SearchLocationWidget;
 	searchResultsWidget?: SearchResultsWidget;
-	searchFacetsWidget?: SearchFacetsWidget;
+	searchFacetsWidget: SearchFacetsWidget[];
 	searchPaginationWidget?: SearchPaginationWidget;
 	searchFeedbackWidget?: SearchFeedbackWidget;
 	searchSortingWidget?: SearchSortingWidget;

package/dist/@searchstax-inc/searchstudio-ux-js.d.ts

@@ -1,35 +1,5 @@
 // Generated by dts-bundle-generator v7.2.0
 
-export interface IFacet {
-	name: string;
-	label: string;
-	values: (IFacetValue | IFacetValueRange)[];
-}
-export interface IFacetValue {
-	value: string;
-	type: "checkbox";
-	parentName: string;
-	count: number;
-}
-export interface IFacetValueRange {
-	valueFrom: string;
-	type: "range";
-	valueTo: string;
-	parentName: string;
-	count: number;
-}
-export interface IFacetData extends IFacet {
-	values: (IFacetValue | IFacetValueRange)[];
-	showingAllFacets?: boolean;
-	hasMoreFacets?: boolean;
-}
-export interface IFacetsTemplateData extends ISearchstaxParsedData {
-	facets: IFacetData[];
-	isMobile?: boolean;
-}
-export interface IFacetValueData extends IFacetValue {
-	disabled?: boolean;
-}
 export interface ISearchstaxParam {
 	q: string;
 	fl: string;
@@ -269,7 +239,6 @@ export interface ISearchstaxParsedData {
 	searchTerm: string;
 	autoCorrectedQuery: string;
 	originalQuery: string;
-	selectedFacets: (IFacetValue | IFacetValueRange)[];
 	relatedSearches: ISearchstaxRelatedSearchResult[];
 	externalPromotions: IExternalPromotion[];
 	answer: string;
@@ -399,6 +368,36 @@ export declare const enum ISearchstaxRenderEngine {
 	"react" = 2,
 	"angular" = 3
 }
+export interface IFacet {
+	name: string;
+	label: string;
+	values: (IFacetValue | IFacetValueRange)[];
+}
+export interface IFacetValue {
+	value: string;
+	type: "checkbox";
+	parentName: string;
+	count: number;
+}
+export interface IFacetValueRange {
+	valueFrom: string;
+	type: "range";
+	valueTo: string;
+	parentName: string;
+	count: number;
+}
+export interface IFacetData extends IFacet {
+	values: (IFacetValue | IFacetValueRange)[];
+	showingAllFacets?: boolean;
+	hasMoreFacets?: boolean;
+}
+export interface IFacetsTemplateData extends ISearchstaxParsedData {
+	facets: IFacetData[];
+	isMobile?: boolean;
+}
+export interface IFacetValueData extends IFacetValue {
+	disabled?: boolean;
+}
 export interface IPaginationData extends ISearchstaxParsedData {
 	nextPageLink: string;
 	previousPageLink: string;
@@ -460,6 +459,7 @@ export interface ISearchstaxSearchInputAutosuggestTemplateData {
 }
 export interface ISearchstaxSearchInputRenderData extends ISearchstaxParsedData {
 	locationEnabled: boolean;
+	hasInputValue: boolean;
 }
 export interface ISearchstaxLocationConfig {
 	templates?: ISearchstaxLocationConfigTemplates;
@@ -522,8 +522,6 @@ declare class DataCalculations {
 	get isInfiniteScroll(): boolean;
 	get answerErrorMessage(): string;
 	get searchExecuted(): boolean;
-	get selectedFacets(): (IFacetValue | IFacetValueRange)[];
-	get cachedANDFacets(): string;
 	get relatedSearches(): ISearchstaxRelatedSearchResult[];
 	get externalPromotions(): IExternalPromotion[];
 	get data(): ISearchstaxParsedData;
@@ -557,7 +555,11 @@ declare class Observable {
 }
 declare class SearchstaxSearchHelper {
 	cachedQuery: string;
+	cachedQueryOR: string;
+	cachedQueryTabs: string;
 	cachedANDFacets: string;
+	cachedORFacets: string;
+	cachedTabsFacets: string;
 	url: string;
 	relatedSearches: string;
 	suggester: string;
@@ -578,9 +580,9 @@ declare class SearchstaxSearchHelper {
 	generateFacetQuery(facets: ISearchstaxSearcObjectFacet[], isOrFaceting: boolean): string;
 	generateLocationQuery(location: ISearchstaxLocation): string;
 	getRelatedSearches(searchObject: ISearchObject, relatedSearchesUrl: string, relatedSearchesAPIKey: string, callback: (resp: ISearchstaxRelatedSearchesResponse) => void): void;
-	cacheFacets(isTabs?: boolean): Promise<void>;
+	cacheFacets(facetingType?: "and" | "or" | "showUnavailable" | "tabs", initalCacheTypes?: ("and" | "or" | "showUnavailable" | "tabs")[]): Promise<void>;
 	private cacheFacetsCallback;
-	search(searchObject: ISearchObject, callback: (resp: ISearchstaxSearchResponse, isTabs: boolean) => void, ignoreCancelation?: boolean, forceNotCorrected?: boolean, isTabs?: boolean): void;
+	search(searchObject: ISearchObject, callback: (resp?: ISearchstaxSearchResponse, facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void, ignoreCancelation?: boolean, forceNotCorrected?: boolean, facetingType?: "and" | "or" | "showUnavailable" | "tabs"): void;
 	generateQueryParams(searchObject: ISearchObject, forceNotCorrected?: boolean): string;
 	startSSE(query: string, callback: (resp: string) => void): EventSource | void;
 	suggest(term: string, callback: (resp: ISearchstaxSuggestResponse) => void, queryParams: IAdditionalProp[]): void;
@@ -600,8 +602,9 @@ declare class DataLAyer {
 	$searchResultsMetadata: Observable;
 	$searchAutosuggest: Observable;
 	$searchFacets: Observable;
-	$searchFacetsCached: Observable;
-	$searchFacetsCachedTabs: Observable;
+	$searchFacetsCachedand: Observable;
+	$searchFacetsCachedor: Observable;
+	$searchFacetsCachedtabs: Observable;
 	$searchstaxConfig: Observable;
 	$autosuggestResults: Observable;
 	$itemsPerPage: Observable;
@@ -664,7 +667,8 @@ declare class DataLAyer {
 	setSearchObject(value: ISearchObject): void;
 	setSearchFacets(value: IFacet[]): void;
 	setSearchFacetsCached(value: IFacet[]): void;
-	setSearchFacetsCachedTabs(value: IFacet[]): void;
+	setSearchFacetsCachedor(value: IFacet[]): void;
+	setSearchFacetsCachedtabs(value: IFacet[]): void;
 	setSearchRelatedSearches(value: ISearchstaxRelatedSearchResult[]): void;
 	setSearchExternalPromotions(value: IExternalPromotion[]): void;
 	setLanguage(value: string): void;
@@ -701,8 +705,9 @@ declare class DataLAyer {
 	get getAnswerData(): any;
 	get searchstaxConfig(): ISearchstaxConfig | null;
 	get searchFacets(): IFacet[] | null;
-	get searchFacetsCached(): IFacet[] | null;
-	get searchFacetsCachedTabs(): IFacet[] | null;
+	get searchFacetsCachedand(): IFacet[] | null;
+	get searchFacetsCachedtabs(): IFacet[] | null;
+	get searchFacetsCachedor(): IFacet[] | null;
 	get searchResults(): ISearchstaxParsedResult[] | null;
 	get searchTerm(): string;
 	get searchLocation(): string;
@@ -942,7 +947,6 @@ declare class SearchFacetsWidget {
 	routerHelper: RouterHelper;
 	cachedPhrase: string;
 	cachedANDFacets: string;
-	isCached: boolean;
 	overlayOpened: boolean;
 	facetPaginationStep: number;
 	facetPaginationStepMobile: number;
@@ -960,14 +964,13 @@ declare class SearchFacetsWidget {
 	};
 	focusedElement: HTMLInputElement | HTMLElement | null;
 	cachedData: IFacetsTemplateData | null;
-	cacheFacets: (isTabs?: boolean) => void;
+	cacheFacets: (facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void;
 	constructor(params: {
 		containerId: string;
 		config: ISearchstaxSearchFacetsConfig;
 		dataLayer: DataLAyer;
 		routerHelper: RouterHelper;
-	}, cacheFacets: (isTabs?: boolean) => void);
-	get needCache(): boolean;
+	}, cacheFacets: (facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void);
 	get needDisabling(): boolean;
 	private initializeSubscriptions;
 	extractFacetValue(data: IFacetValueData): ISearchstaxSearcObjectFacet;
@@ -987,6 +990,7 @@ declare class SearchFacetsWidget {
 	attachOnclickToShowMore(data: IFacetData, container: Element, isMobile?: boolean): void;
 	onShowMoreLessClick(e: Event, data: IFacetData, isMobile?: boolean): void;
 	private renderMainTemplate;
+	private get componentFacets();
 	generateSelectedFacetsData(): void;
 	createSelectedFacetsComponents(container: Element): void;
 	createClearFacetsComponents(container: Element): void;
@@ -1068,9 +1072,12 @@ declare class SearchInputWidget {
 	private containerId;
 	private currentInputValue;
 	autosuggestResults?: ISearchstaxSEARCHTERM;
+	private suppressNextEnter;
 	private searchInput?;
 	private actionButton?;
 	private autosuggestContainer?;
+	private clearButton?;
+	private separatorIcon?;
 	private buttonState;
 	private selectedAutosuggestItem;
 	private suggestTrigger;
@@ -1086,6 +1093,7 @@ declare class SearchInputWidget {
 	private createAutosuggestContainer;
 	private getSuggestAfterValue;
 	private actionButtonInit;
+	private updateClearButtonVisibility;
 	private attachSubscriptions;
 	private handleLoadingChange;
 	private handleSearchTermChange;
@@ -1093,6 +1101,7 @@ declare class SearchInputWidget {
 	selectPreviousAutosuggestItem(input: HTMLInputElement): void;
 	selectNextAutosuggestItem(): void;
 	resetAutosuggestSelection(): void;
+	clearInput(): void;
 	markActiveAutosuggestItem(): void;
 	private inputKeyupEvent;
 	private autosuggestHandling;
@@ -1158,6 +1167,7 @@ declare class AnswersWidget {
 	renderFeedbackWidget: boolean;
 	clicked: boolean;
 	renderedWithShowMore: boolean;
+	private showMoreListenerAttached;
 	constructor(params: {
 		containerId: string;
 		config: ISearchstaxAnswerConfig;
@@ -1167,7 +1177,7 @@ declare class AnswersWidget {
 	searchstaxFeedbackTextAreaOverride(): string;
 	initializeWidget(): void;
 	showMore(e: Event): void;
-	private attachClickEventToShowMore;
+	private attachShowMoreClickListener;
 	trackLinkClick(e: Event): void;
 	attachLinkTracking(): void;
 	private renderMainTemplate;
@@ -1213,7 +1223,7 @@ export declare class Searchstax {
 	searchInputWidget?: SearchInputWidget;
 	searchLocationWidget?: SearchLocationWidget;
 	searchResultsWidget?: SearchResultsWidget;
-	searchFacetsWidget?: SearchFacetsWidget;
+	searchFacetsWidget: SearchFacetsWidget[];
 	searchPaginationWidget?: SearchPaginationWidget;
 	searchFeedbackWidget?: SearchFeedbackWidget;
 	searchSortingWidget?: SearchSortingWidget;