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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/CHANGELOG.md +5 -0
  2. package/dist/@searchstax-inc/searchstudio-ux-js.cjs +67 -67
  3. package/dist/@searchstax-inc/searchstudio-ux-js.d.mts +48 -45
  4. package/dist/@searchstax-inc/searchstudio-ux-js.d.ts +48 -45
  5. package/dist/@searchstax-inc/searchstudio-ux-js.iife.js +66 -66
  6. package/dist/@searchstax-inc/searchstudio-ux-js.mjs +64 -64
  7. package/package.json +1 -1
package/dist/@searchstax-inc/searchstudio-ux-js.d.mts CHANGED
@@ -1,35 +1,5 @@
1
1
  // Generated by dts-bundle-generator v7.2.0
2
2
 
3
- export interface IFacet {
4
- name: string;
5
- label: string;
6
- values: (IFacetValue | IFacetValueRange)[];
7
- }
8
- export interface IFacetValue {
9
- value: string;
10
- type: "checkbox";
11
- parentName: string;
12
- count: number;
13
- }
14
- export interface IFacetValueRange {
15
- valueFrom: string;
16
- type: "range";
17
- valueTo: string;
18
- parentName: string;
19
- count: number;
20
- }
21
- export interface IFacetData extends IFacet {
22
- values: (IFacetValue | IFacetValueRange)[];
23
- showingAllFacets?: boolean;
24
- hasMoreFacets?: boolean;
25
- }
26
- export interface IFacetsTemplateData extends ISearchstaxParsedData {
27
- facets: IFacetData[];
28
- isMobile?: boolean;
29
- }
30
- export interface IFacetValueData extends IFacetValue {
31
- disabled?: boolean;
32
- }
33
3
  export interface ISearchstaxParam {
34
4
  q: string;
35
5
  fl: string;
@@ -269,7 +239,6 @@ export interface ISearchstaxParsedData {
269
239
  searchTerm: string;
270
240
  autoCorrectedQuery: string;
271
241
  originalQuery: string;
272
- selectedFacets: (IFacetValue | IFacetValueRange)[];
273
242
  relatedSearches: ISearchstaxRelatedSearchResult[];
274
243
  externalPromotions: IExternalPromotion[];
275
244
  answer: string;
@@ -399,6 +368,36 @@ export declare const enum ISearchstaxRenderEngine {
399
368
  "react" = 2,
400
369
  "angular" = 3
401
370
  }
371
+ export interface IFacet {
372
+ name: string;
373
+ label: string;
374
+ values: (IFacetValue | IFacetValueRange)[];
375
+ }
376
+ export interface IFacetValue {
377
+ value: string;
378
+ type: "checkbox";
379
+ parentName: string;
380
+ count: number;
381
+ }
382
+ export interface IFacetValueRange {
383
+ valueFrom: string;
384
+ type: "range";
385
+ valueTo: string;
386
+ parentName: string;
387
+ count: number;
388
+ }
389
+ export interface IFacetData extends IFacet {
390
+ values: (IFacetValue | IFacetValueRange)[];
391
+ showingAllFacets?: boolean;
392
+ hasMoreFacets?: boolean;
393
+ }
394
+ export interface IFacetsTemplateData extends ISearchstaxParsedData {
395
+ facets: IFacetData[];
396
+ isMobile?: boolean;
397
+ }
398
+ export interface IFacetValueData extends IFacetValue {
399
+ disabled?: boolean;
400
+ }
402
401
  export interface IPaginationData extends ISearchstaxParsedData {
403
402
  nextPageLink: string;
404
403
  previousPageLink: string;
@@ -523,8 +522,6 @@ declare class DataCalculations {
523
522
  get isInfiniteScroll(): boolean;
524
523
  get answerErrorMessage(): string;
525
524
  get searchExecuted(): boolean;
526
- get selectedFacets(): (IFacetValue | IFacetValueRange)[];
527
- get cachedANDFacets(): string;
528
525
  get relatedSearches(): ISearchstaxRelatedSearchResult[];
529
526
  get externalPromotions(): IExternalPromotion[];
530
527
  get data(): ISearchstaxParsedData;
@@ -558,7 +555,11 @@ declare class Observable {
558
555
  }
559
556
  declare class SearchstaxSearchHelper {
560
557
  cachedQuery: string;
558
+ cachedQueryOR: string;
559
+ cachedQueryTabs: string;
561
560
  cachedANDFacets: string;
561
+ cachedORFacets: string;
562
+ cachedTabsFacets: string;
562
563
  url: string;
563
564
  relatedSearches: string;
564
565
  suggester: string;
@@ -579,9 +580,9 @@ declare class SearchstaxSearchHelper {
579
580
  generateFacetQuery(facets: ISearchstaxSearcObjectFacet[], isOrFaceting: boolean): string;
580
581
  generateLocationQuery(location: ISearchstaxLocation): string;
581
582
  getRelatedSearches(searchObject: ISearchObject, relatedSearchesUrl: string, relatedSearchesAPIKey: string, callback: (resp: ISearchstaxRelatedSearchesResponse) => void): void;
582
- cacheFacets(isTabs?: boolean): Promise<void>;
583
+ cacheFacets(facetingType?: "and" | "or" | "showUnavailable" | "tabs", initalCacheTypes?: ("and" | "or" | "showUnavailable" | "tabs")[]): Promise<void>;
583
584
  private cacheFacetsCallback;
584
- search(searchObject: ISearchObject, callback: (resp: ISearchstaxSearchResponse, isTabs: boolean) => void, ignoreCancelation?: boolean, forceNotCorrected?: boolean, isTabs?: boolean): void;
585
+ search(searchObject: ISearchObject, callback: (resp?: ISearchstaxSearchResponse, facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void, ignoreCancelation?: boolean, forceNotCorrected?: boolean, facetingType?: "and" | "or" | "showUnavailable" | "tabs"): void;
585
586
  generateQueryParams(searchObject: ISearchObject, forceNotCorrected?: boolean): string;
586
587
  startSSE(query: string, callback: (resp: string) => void): EventSource | void;
587
588
  suggest(term: string, callback: (resp: ISearchstaxSuggestResponse) => void, queryParams: IAdditionalProp[]): void;
@@ -601,8 +602,9 @@ declare class DataLAyer {
601
602
  $searchResultsMetadata: Observable;
602
603
  $searchAutosuggest: Observable;
603
604
  $searchFacets: Observable;
604
- $searchFacetsCached: Observable;
605
- $searchFacetsCachedTabs: Observable;
605
+ $searchFacetsCachedand: Observable;
606
+ $searchFacetsCachedor: Observable;
607
+ $searchFacetsCachedtabs: Observable;
606
608
  $searchstaxConfig: Observable;
607
609
  $autosuggestResults: Observable;
608
610
  $itemsPerPage: Observable;
@@ -665,7 +667,8 @@ declare class DataLAyer {
665
667
  setSearchObject(value: ISearchObject): void;
666
668
  setSearchFacets(value: IFacet[]): void;
667
669
  setSearchFacetsCached(value: IFacet[]): void;
668
- setSearchFacetsCachedTabs(value: IFacet[]): void;
670
+ setSearchFacetsCachedor(value: IFacet[]): void;
671
+ setSearchFacetsCachedtabs(value: IFacet[]): void;
669
672
  setSearchRelatedSearches(value: ISearchstaxRelatedSearchResult[]): void;
670
673
  setSearchExternalPromotions(value: IExternalPromotion[]): void;
671
674
  setLanguage(value: string): void;
@@ -702,8 +705,9 @@ declare class DataLAyer {
702
705
  get getAnswerData(): any;
703
706
  get searchstaxConfig(): ISearchstaxConfig | null;
704
707
  get searchFacets(): IFacet[] | null;
705
- get searchFacetsCached(): IFacet[] | null;
706
- get searchFacetsCachedTabs(): IFacet[] | null;
708
+ get searchFacetsCachedand(): IFacet[] | null;
709
+ get searchFacetsCachedtabs(): IFacet[] | null;
710
+ get searchFacetsCachedor(): IFacet[] | null;
707
711
  get searchResults(): ISearchstaxParsedResult[] | null;
708
712
  get searchTerm(): string;
709
713
  get searchLocation(): string;
@@ -943,7 +947,6 @@ declare class SearchFacetsWidget {
943
947
  routerHelper: RouterHelper;
944
948
  cachedPhrase: string;
945
949
  cachedANDFacets: string;
946
- isCached: boolean;
947
950
  overlayOpened: boolean;
948
951
  facetPaginationStep: number;
949
952
  facetPaginationStepMobile: number;
@@ -961,14 +964,13 @@ declare class SearchFacetsWidget {
961
964
  };
962
965
  focusedElement: HTMLInputElement | HTMLElement | null;
963
966
  cachedData: IFacetsTemplateData | null;
964
- cacheFacets: (isTabs?: boolean) => void;
967
+ cacheFacets: (facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void;
965
968
  constructor(params: {
966
969
  containerId: string;
967
970
  config: ISearchstaxSearchFacetsConfig;
968
971
  dataLayer: DataLAyer;
969
972
  routerHelper: RouterHelper;
970
- }, cacheFacets: (isTabs?: boolean) => void);
971
- get needCache(): boolean;
973
+ }, cacheFacets: (facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void);
972
974
  get needDisabling(): boolean;
973
975
  private initializeSubscriptions;
974
976
  extractFacetValue(data: IFacetValueData): ISearchstaxSearcObjectFacet;
@@ -988,6 +990,7 @@ declare class SearchFacetsWidget {
988
990
  attachOnclickToShowMore(data: IFacetData, container: Element, isMobile?: boolean): void;
989
991
  onShowMoreLessClick(e: Event, data: IFacetData, isMobile?: boolean): void;
990
992
  private renderMainTemplate;
993
+ private get componentFacets();
991
994
  generateSelectedFacetsData(): void;
992
995
  createSelectedFacetsComponents(container: Element): void;
993
996
  createClearFacetsComponents(container: Element): void;
@@ -1220,7 +1223,7 @@ export declare class Searchstax {
1220
1223
  searchInputWidget?: SearchInputWidget;
1221
1224
  searchLocationWidget?: SearchLocationWidget;
1222
1225
  searchResultsWidget?: SearchResultsWidget;
1223
- searchFacetsWidget?: SearchFacetsWidget;
1226
+ searchFacetsWidget: SearchFacetsWidget[];
1224
1227
  searchPaginationWidget?: SearchPaginationWidget;
1225
1228
  searchFeedbackWidget?: SearchFeedbackWidget;
1226
1229
  searchSortingWidget?: SearchSortingWidget;
package/dist/@searchstax-inc/searchstudio-ux-js.d.ts CHANGED
@@ -1,35 +1,5 @@
1
1
  // Generated by dts-bundle-generator v7.2.0
2
2
 
3
- export interface IFacet {
4
- name: string;
5
- label: string;
6
- values: (IFacetValue | IFacetValueRange)[];
7
- }
8
- export interface IFacetValue {
9
- value: string;
10
- type: "checkbox";
11
- parentName: string;
12
- count: number;
13
- }
14
- export interface IFacetValueRange {
15
- valueFrom: string;
16
- type: "range";
17
- valueTo: string;
18
- parentName: string;
19
- count: number;
20
- }
21
- export interface IFacetData extends IFacet {
22
- values: (IFacetValue | IFacetValueRange)[];
23
- showingAllFacets?: boolean;
24
- hasMoreFacets?: boolean;
25
- }
26
- export interface IFacetsTemplateData extends ISearchstaxParsedData {
27
- facets: IFacetData[];
28
- isMobile?: boolean;
29
- }
30
- export interface IFacetValueData extends IFacetValue {
31
- disabled?: boolean;
32
- }
33
3
  export interface ISearchstaxParam {
34
4
  q: string;
35
5
  fl: string;
@@ -269,7 +239,6 @@ export interface ISearchstaxParsedData {
269
239
  searchTerm: string;
270
240
  autoCorrectedQuery: string;
271
241
  originalQuery: string;
272
- selectedFacets: (IFacetValue | IFacetValueRange)[];
273
242
  relatedSearches: ISearchstaxRelatedSearchResult[];
274
243
  externalPromotions: IExternalPromotion[];
275
244
  answer: string;
@@ -399,6 +368,36 @@ export declare const enum ISearchstaxRenderEngine {
399
368
  "react" = 2,
400
369
  "angular" = 3
401
370
  }
371
+ export interface IFacet {
372
+ name: string;
373
+ label: string;
374
+ values: (IFacetValue | IFacetValueRange)[];
375
+ }
376
+ export interface IFacetValue {
377
+ value: string;
378
+ type: "checkbox";
379
+ parentName: string;
380
+ count: number;
381
+ }
382
+ export interface IFacetValueRange {
383
+ valueFrom: string;
384
+ type: "range";
385
+ valueTo: string;
386
+ parentName: string;
387
+ count: number;
388
+ }
389
+ export interface IFacetData extends IFacet {
390
+ values: (IFacetValue | IFacetValueRange)[];
391
+ showingAllFacets?: boolean;
392
+ hasMoreFacets?: boolean;
393
+ }
394
+ export interface IFacetsTemplateData extends ISearchstaxParsedData {
395
+ facets: IFacetData[];
396
+ isMobile?: boolean;
397
+ }
398
+ export interface IFacetValueData extends IFacetValue {
399
+ disabled?: boolean;
400
+ }
402
401
  export interface IPaginationData extends ISearchstaxParsedData {
403
402
  nextPageLink: string;
404
403
  previousPageLink: string;
@@ -523,8 +522,6 @@ declare class DataCalculations {
523
522
  get isInfiniteScroll(): boolean;
524
523
  get answerErrorMessage(): string;
525
524
  get searchExecuted(): boolean;
526
- get selectedFacets(): (IFacetValue | IFacetValueRange)[];
527
- get cachedANDFacets(): string;
528
525
  get relatedSearches(): ISearchstaxRelatedSearchResult[];
529
526
  get externalPromotions(): IExternalPromotion[];
530
527
  get data(): ISearchstaxParsedData;
@@ -558,7 +555,11 @@ declare class Observable {
558
555
  }
559
556
  declare class SearchstaxSearchHelper {
560
557
  cachedQuery: string;
558
+ cachedQueryOR: string;
559
+ cachedQueryTabs: string;
561
560
  cachedANDFacets: string;
561
+ cachedORFacets: string;
562
+ cachedTabsFacets: string;
562
563
  url: string;
563
564
  relatedSearches: string;
564
565
  suggester: string;
@@ -579,9 +580,9 @@ declare class SearchstaxSearchHelper {
579
580
  generateFacetQuery(facets: ISearchstaxSearcObjectFacet[], isOrFaceting: boolean): string;
580
581
  generateLocationQuery(location: ISearchstaxLocation): string;
581
582
  getRelatedSearches(searchObject: ISearchObject, relatedSearchesUrl: string, relatedSearchesAPIKey: string, callback: (resp: ISearchstaxRelatedSearchesResponse) => void): void;
582
- cacheFacets(isTabs?: boolean): Promise<void>;
583
+ cacheFacets(facetingType?: "and" | "or" | "showUnavailable" | "tabs", initalCacheTypes?: ("and" | "or" | "showUnavailable" | "tabs")[]): Promise<void>;
583
584
  private cacheFacetsCallback;
584
- search(searchObject: ISearchObject, callback: (resp: ISearchstaxSearchResponse, isTabs: boolean) => void, ignoreCancelation?: boolean, forceNotCorrected?: boolean, isTabs?: boolean): void;
585
+ search(searchObject: ISearchObject, callback: (resp?: ISearchstaxSearchResponse, facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void, ignoreCancelation?: boolean, forceNotCorrected?: boolean, facetingType?: "and" | "or" | "showUnavailable" | "tabs"): void;
585
586
  generateQueryParams(searchObject: ISearchObject, forceNotCorrected?: boolean): string;
586
587
  startSSE(query: string, callback: (resp: string) => void): EventSource | void;
587
588
  suggest(term: string, callback: (resp: ISearchstaxSuggestResponse) => void, queryParams: IAdditionalProp[]): void;
@@ -601,8 +602,9 @@ declare class DataLAyer {
601
602
  $searchResultsMetadata: Observable;
602
603
  $searchAutosuggest: Observable;
603
604
  $searchFacets: Observable;
604
- $searchFacetsCached: Observable;
605
- $searchFacetsCachedTabs: Observable;
605
+ $searchFacetsCachedand: Observable;
606
+ $searchFacetsCachedor: Observable;
607
+ $searchFacetsCachedtabs: Observable;
606
608
  $searchstaxConfig: Observable;
607
609
  $autosuggestResults: Observable;
608
610
  $itemsPerPage: Observable;
@@ -665,7 +667,8 @@ declare class DataLAyer {
665
667
  setSearchObject(value: ISearchObject): void;
666
668
  setSearchFacets(value: IFacet[]): void;
667
669
  setSearchFacetsCached(value: IFacet[]): void;
668
- setSearchFacetsCachedTabs(value: IFacet[]): void;
670
+ setSearchFacetsCachedor(value: IFacet[]): void;
671
+ setSearchFacetsCachedtabs(value: IFacet[]): void;
669
672
  setSearchRelatedSearches(value: ISearchstaxRelatedSearchResult[]): void;
670
673
  setSearchExternalPromotions(value: IExternalPromotion[]): void;
671
674
  setLanguage(value: string): void;
@@ -702,8 +705,9 @@ declare class DataLAyer {
702
705
  get getAnswerData(): any;
703
706
  get searchstaxConfig(): ISearchstaxConfig | null;
704
707
  get searchFacets(): IFacet[] | null;
705
- get searchFacetsCached(): IFacet[] | null;
706
- get searchFacetsCachedTabs(): IFacet[] | null;
708
+ get searchFacetsCachedand(): IFacet[] | null;
709
+ get searchFacetsCachedtabs(): IFacet[] | null;
710
+ get searchFacetsCachedor(): IFacet[] | null;
707
711
  get searchResults(): ISearchstaxParsedResult[] | null;
708
712
  get searchTerm(): string;
709
713
  get searchLocation(): string;
@@ -943,7 +947,6 @@ declare class SearchFacetsWidget {
943
947
  routerHelper: RouterHelper;
944
948
  cachedPhrase: string;
945
949
  cachedANDFacets: string;
946
- isCached: boolean;
947
950
  overlayOpened: boolean;
948
951
  facetPaginationStep: number;
949
952
  facetPaginationStepMobile: number;
@@ -961,14 +964,13 @@ declare class SearchFacetsWidget {
961
964
  };
962
965
  focusedElement: HTMLInputElement | HTMLElement | null;
963
966
  cachedData: IFacetsTemplateData | null;
964
- cacheFacets: (isTabs?: boolean) => void;
967
+ cacheFacets: (facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void;
965
968
  constructor(params: {
966
969
  containerId: string;
967
970
  config: ISearchstaxSearchFacetsConfig;
968
971
  dataLayer: DataLAyer;
969
972
  routerHelper: RouterHelper;
970
- }, cacheFacets: (isTabs?: boolean) => void);
971
- get needCache(): boolean;
973
+ }, cacheFacets: (facetingType?: "and" | "or" | "showUnavailable" | "tabs") => void);
972
974
  get needDisabling(): boolean;
973
975
  private initializeSubscriptions;
974
976
  extractFacetValue(data: IFacetValueData): ISearchstaxSearcObjectFacet;
@@ -988,6 +990,7 @@ declare class SearchFacetsWidget {
988
990
  attachOnclickToShowMore(data: IFacetData, container: Element, isMobile?: boolean): void;
989
991
  onShowMoreLessClick(e: Event, data: IFacetData, isMobile?: boolean): void;
990
992
  private renderMainTemplate;
993
+ private get componentFacets();
991
994
  generateSelectedFacetsData(): void;
992
995
  createSelectedFacetsComponents(container: Element): void;
993
996
  createClearFacetsComponents(container: Element): void;
@@ -1220,7 +1223,7 @@ export declare class Searchstax {
1220
1223
  searchInputWidget?: SearchInputWidget;
1221
1224
  searchLocationWidget?: SearchLocationWidget;
1222
1225
  searchResultsWidget?: SearchResultsWidget;
1223
- searchFacetsWidget?: SearchFacetsWidget;
1226
+ searchFacetsWidget: SearchFacetsWidget[];
1224
1227
  searchPaginationWidget?: SearchPaginationWidget;
1225
1228
  searchFeedbackWidget?: SearchFeedbackWidget;
1226
1229
  searchSortingWidget?: SearchSortingWidget;