@wix/search 1.0.23 → 1.0.24
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.
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/search",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.24",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"type-bundles"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@wix/search_site-search": "1.0.
|
|
21
|
+
"@wix/search_site-search": "1.0.17",
|
|
22
22
|
"@wix/search_wix-site-search": "1.0.3"
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
@@ -44,5 +44,5 @@
|
|
|
44
44
|
"fqdn": ""
|
|
45
45
|
}
|
|
46
46
|
},
|
|
47
|
-
"falconPackageHash": "
|
|
47
|
+
"falconPackageHash": "a36d7bb21b35da55eb87cc4fabff6b0b2155316b3859b6c9ed5da303"
|
|
48
48
|
}
|
|
@@ -460,6 +460,61 @@ interface SumAggregationResponse {
|
|
|
460
460
|
/** The sum value across all documents */
|
|
461
461
|
value?: number | null;
|
|
462
462
|
}
|
|
463
|
+
interface FederatedSearchResponse {
|
|
464
|
+
/** Search results from multiple indexes. */
|
|
465
|
+
results?: FederatedSearchDocuments[];
|
|
466
|
+
}
|
|
467
|
+
interface FederatedSearchDocuments {
|
|
468
|
+
/** Document type of documents */
|
|
469
|
+
documentType?: string | null;
|
|
470
|
+
/** Documents of document type */
|
|
471
|
+
documents?: Record<string, any>[] | null;
|
|
472
|
+
/** Total count of matching documents for document type */
|
|
473
|
+
total?: number;
|
|
474
|
+
}
|
|
475
|
+
interface SuggestResponse {
|
|
476
|
+
/** Suggested documents. */
|
|
477
|
+
documents?: Record<string, any>[] | null;
|
|
478
|
+
}
|
|
479
|
+
interface FederatedSuggestResponse {
|
|
480
|
+
/** Suggest results from multiple indexes. */
|
|
481
|
+
results?: FederatedSuggestDocuments[];
|
|
482
|
+
}
|
|
483
|
+
interface FederatedSuggestDocuments {
|
|
484
|
+
/** Document type of documents */
|
|
485
|
+
documentType?: string | null;
|
|
486
|
+
/** Documents of document type */
|
|
487
|
+
documents?: Record<string, any>[] | null;
|
|
488
|
+
}
|
|
489
|
+
interface RelatedResponse {
|
|
490
|
+
/** Documents matching filter and query. */
|
|
491
|
+
documents?: Record<string, any>[] | null;
|
|
492
|
+
}
|
|
493
|
+
interface AutocompleteResponse {
|
|
494
|
+
/** Suggested phrases. */
|
|
495
|
+
values?: AutocompleteResponseValue[];
|
|
496
|
+
}
|
|
497
|
+
interface AutocompleteResponseValue {
|
|
498
|
+
/** Suggested phrase. */
|
|
499
|
+
query?: string;
|
|
500
|
+
}
|
|
501
|
+
interface FederatedAutocompleteResponse {
|
|
502
|
+
/** Suggested phrases from multiple indexes */
|
|
503
|
+
results?: FederatedAutocompleteResults[];
|
|
504
|
+
}
|
|
505
|
+
interface FederatedAutocompleteResults {
|
|
506
|
+
/** Document type of queries */
|
|
507
|
+
documentType?: string | null;
|
|
508
|
+
/** Suggested phrases */
|
|
509
|
+
values?: AutocompleteResponseValue[];
|
|
510
|
+
}
|
|
511
|
+
interface TrendingResponse {
|
|
512
|
+
results?: TrendingItems[];
|
|
513
|
+
}
|
|
514
|
+
interface TrendingItems {
|
|
515
|
+
documentType?: string;
|
|
516
|
+
documents?: Record<string, any>[] | null;
|
|
517
|
+
}
|
|
463
518
|
interface SearchResponseNonNullableFields {
|
|
464
519
|
nextPage?: {
|
|
465
520
|
total: number;
|
|
@@ -495,6 +550,31 @@ interface SearchResponseNonNullableFields {
|
|
|
495
550
|
};
|
|
496
551
|
}[];
|
|
497
552
|
}
|
|
553
|
+
interface FederatedSearchResponseNonNullableFields {
|
|
554
|
+
results: {
|
|
555
|
+
total: number;
|
|
556
|
+
}[];
|
|
557
|
+
}
|
|
558
|
+
interface FederatedSuggestResponseNonNullableFields {
|
|
559
|
+
results: FederatedSuggestDocuments[];
|
|
560
|
+
}
|
|
561
|
+
interface AutocompleteResponseNonNullableFields {
|
|
562
|
+
values: {
|
|
563
|
+
query: string;
|
|
564
|
+
}[];
|
|
565
|
+
}
|
|
566
|
+
interface FederatedAutocompleteResponseNonNullableFields {
|
|
567
|
+
results: {
|
|
568
|
+
values: {
|
|
569
|
+
query: string;
|
|
570
|
+
}[];
|
|
571
|
+
}[];
|
|
572
|
+
}
|
|
573
|
+
interface TrendingResponseNonNullableFields {
|
|
574
|
+
results: {
|
|
575
|
+
documentType: string;
|
|
576
|
+
}[];
|
|
577
|
+
}
|
|
498
578
|
interface SearchOptions {
|
|
499
579
|
/** Text to search for. All searchable fields will be searched. */
|
|
500
580
|
query?: string | null;
|
|
@@ -523,14 +603,147 @@ interface SearchOptions {
|
|
|
523
603
|
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
524
604
|
includeSeoHidden?: boolean | null;
|
|
525
605
|
}
|
|
606
|
+
interface FederatedSearchOptions {
|
|
607
|
+
/** Query phrase to use. */
|
|
608
|
+
query?: string | null;
|
|
609
|
+
/** Language to search in. */
|
|
610
|
+
language?: string | null;
|
|
611
|
+
/** Limit of documents to return per document type. */
|
|
612
|
+
limit?: number | null;
|
|
613
|
+
/** Enable fuzzy search (for example query 'kalvin clein' will match document with 'calvin klein' in title). */
|
|
614
|
+
fuzzy?: boolean | null;
|
|
615
|
+
/** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
|
|
616
|
+
highlight?: boolean | null;
|
|
617
|
+
/** Searchable fields to search in. If not provided, search is executed on all searchable fields in schemas */
|
|
618
|
+
searchFields?: string[];
|
|
619
|
+
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
620
|
+
documentTypes?: string[];
|
|
621
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
622
|
+
includeSeoHidden?: boolean | null;
|
|
623
|
+
}
|
|
624
|
+
interface SuggestOptions {
|
|
625
|
+
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
626
|
+
query?: string | null;
|
|
627
|
+
/** Document type of documents to search for. All document types are searched if not provided. */
|
|
628
|
+
documentType?: string | null;
|
|
629
|
+
/** Fields to order by. */
|
|
630
|
+
ordering?: OrderingClauses;
|
|
631
|
+
/** Number of suggested document to return. */
|
|
632
|
+
limit?: number;
|
|
633
|
+
/** Language to search in. */
|
|
634
|
+
language?: string | null;
|
|
635
|
+
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
|
|
636
|
+
filter?: Record<string, any> | null;
|
|
637
|
+
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schema */
|
|
638
|
+
searchFields?: string[];
|
|
639
|
+
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
640
|
+
fields?: string[];
|
|
641
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
642
|
+
includeSeoHidden?: boolean | null;
|
|
643
|
+
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
|
|
644
|
+
properties?: SearchProperty[];
|
|
645
|
+
}
|
|
646
|
+
interface FederatedSuggestOptions {
|
|
647
|
+
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
648
|
+
query?: string | null;
|
|
649
|
+
/** Language to search in. */
|
|
650
|
+
language?: string | null;
|
|
651
|
+
/** Number of suggested document to return per document type. */
|
|
652
|
+
limit?: number;
|
|
653
|
+
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schemas */
|
|
654
|
+
searchFields?: string[];
|
|
655
|
+
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
656
|
+
documentTypes?: string[];
|
|
657
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
658
|
+
includeSeoHidden?: boolean | null;
|
|
659
|
+
}
|
|
660
|
+
interface RelatedOptions {
|
|
661
|
+
/** ID of the document to fetch related documents for. */
|
|
662
|
+
documentId?: string | null;
|
|
663
|
+
/** Document type of the document. */
|
|
664
|
+
documentType?: string | null;
|
|
665
|
+
/** Fields to order by. */
|
|
666
|
+
ordering?: OrderingClauses;
|
|
667
|
+
/** Language to search in. */
|
|
668
|
+
language?: string | null;
|
|
669
|
+
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}). */
|
|
670
|
+
filter?: Record<string, any> | null;
|
|
671
|
+
/** Searchable fields to compare documents by. If not provided, all searchable fields in schema are used */
|
|
672
|
+
searchFields?: string[];
|
|
673
|
+
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
674
|
+
fields?: string[];
|
|
675
|
+
/** Number of related documents to return */
|
|
676
|
+
limit?: number;
|
|
677
|
+
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
|
|
678
|
+
properties?: SearchProperty[];
|
|
679
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
680
|
+
includeSeoHidden?: boolean | null;
|
|
681
|
+
}
|
|
682
|
+
interface AutocompleteOptions {
|
|
683
|
+
/** Query phrase to fetch completions for. */
|
|
684
|
+
query?: string | null;
|
|
685
|
+
/** Document type to use to search for phrases. */
|
|
686
|
+
documentType?: string | null;
|
|
687
|
+
/** Limit of phrases to fetch. */
|
|
688
|
+
limit?: number;
|
|
689
|
+
/** Language to search in. */
|
|
690
|
+
language?: string | null;
|
|
691
|
+
/** Filter in platfromized query language (for example {'field': {'$eq': 'value'}}) */
|
|
692
|
+
filter?: Record<string, any> | null;
|
|
693
|
+
/** Searchable fields to use for query completion. If not provided, all searchable fields in schema are used */
|
|
694
|
+
searchFields?: string[];
|
|
695
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
696
|
+
includeSeoHidden?: boolean | null;
|
|
697
|
+
}
|
|
698
|
+
interface FederatedAutocompleteOptions {
|
|
699
|
+
/** Query phrase to fetch completions for. */
|
|
700
|
+
query?: string | null;
|
|
701
|
+
/** Language to search in. */
|
|
702
|
+
language?: string | null;
|
|
703
|
+
/** Number of queries to return per document type. */
|
|
704
|
+
limit?: number;
|
|
705
|
+
/** Searchable fields to search in. If not provided, search is executed on all autocompletable fields in schemas */
|
|
706
|
+
searchFields?: string[];
|
|
707
|
+
/** Document types to autocomplete in. If not provided, autocomplete is executed on all document types enabled for the site */
|
|
708
|
+
documentTypes?: string[];
|
|
709
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
710
|
+
includeSeoHidden?: boolean | null;
|
|
711
|
+
}
|
|
712
|
+
interface TrendingOptions {
|
|
713
|
+
documentTypes?: string[];
|
|
714
|
+
language?: string | null;
|
|
715
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
716
|
+
includeSeoHidden?: boolean | null;
|
|
717
|
+
}
|
|
526
718
|
|
|
527
719
|
declare function search$1(httpClient: HttpClient): (options?: SearchOptions) => Promise<SearchResponse & SearchResponseNonNullableFields>;
|
|
720
|
+
declare function federatedSearch$1(httpClient: HttpClient): (options?: FederatedSearchOptions) => Promise<FederatedSearchResponse & FederatedSearchResponseNonNullableFields>;
|
|
721
|
+
declare function suggest$1(httpClient: HttpClient): (options?: SuggestOptions) => Promise<SuggestResponse>;
|
|
722
|
+
declare function federatedSuggest$1(httpClient: HttpClient): (options?: FederatedSuggestOptions) => Promise<FederatedSuggestResponse & FederatedSuggestResponseNonNullableFields>;
|
|
723
|
+
declare function related$1(httpClient: HttpClient): (options?: RelatedOptions) => Promise<RelatedResponse>;
|
|
724
|
+
declare function autocomplete$1(httpClient: HttpClient): (options?: AutocompleteOptions) => Promise<AutocompleteResponse & AutocompleteResponseNonNullableFields>;
|
|
725
|
+
declare function federatedAutocomplete$1(httpClient: HttpClient): (options?: FederatedAutocompleteOptions) => Promise<FederatedAutocompleteResponse & FederatedAutocompleteResponseNonNullableFields>;
|
|
726
|
+
declare function trending$1(httpClient: HttpClient): (options?: TrendingOptions) => Promise<TrendingResponse & TrendingResponseNonNullableFields>;
|
|
528
727
|
|
|
529
728
|
declare const search: BuildRESTFunction<typeof search$1>;
|
|
729
|
+
declare const federatedSearch: BuildRESTFunction<typeof federatedSearch$1>;
|
|
730
|
+
declare const suggest: BuildRESTFunction<typeof suggest$1>;
|
|
731
|
+
declare const federatedSuggest: BuildRESTFunction<typeof federatedSuggest$1>;
|
|
732
|
+
declare const related: BuildRESTFunction<typeof related$1>;
|
|
733
|
+
declare const autocomplete: BuildRESTFunction<typeof autocomplete$1>;
|
|
734
|
+
declare const federatedAutocomplete: BuildRESTFunction<typeof federatedAutocomplete$1>;
|
|
735
|
+
declare const trending: BuildRESTFunction<typeof trending$1>;
|
|
530
736
|
|
|
737
|
+
declare const context_autocomplete: typeof autocomplete;
|
|
738
|
+
declare const context_federatedAutocomplete: typeof federatedAutocomplete;
|
|
739
|
+
declare const context_federatedSearch: typeof federatedSearch;
|
|
740
|
+
declare const context_federatedSuggest: typeof federatedSuggest;
|
|
741
|
+
declare const context_related: typeof related;
|
|
531
742
|
declare const context_search: typeof search;
|
|
743
|
+
declare const context_suggest: typeof suggest;
|
|
744
|
+
declare const context_trending: typeof trending;
|
|
532
745
|
declare namespace context {
|
|
533
|
-
export { context_search as search };
|
|
746
|
+
export { context_autocomplete as autocomplete, context_federatedAutocomplete as federatedAutocomplete, context_federatedSearch as federatedSearch, context_federatedSuggest as federatedSuggest, context_related as related, context_search as search, context_suggest as suggest, context_trending as trending };
|
|
534
747
|
}
|
|
535
748
|
|
|
536
749
|
export { context as siteSearch, context$1 as wixSiteSearch };
|
|
@@ -977,6 +977,31 @@ interface SearchResponseNonNullableFields {
|
|
|
977
977
|
};
|
|
978
978
|
}[];
|
|
979
979
|
}
|
|
980
|
+
interface FederatedSearchResponseNonNullableFields {
|
|
981
|
+
results: {
|
|
982
|
+
total: number;
|
|
983
|
+
}[];
|
|
984
|
+
}
|
|
985
|
+
interface FederatedSuggestResponseNonNullableFields {
|
|
986
|
+
results: FederatedSuggestDocuments[];
|
|
987
|
+
}
|
|
988
|
+
interface AutocompleteResponseNonNullableFields {
|
|
989
|
+
values: {
|
|
990
|
+
query: string;
|
|
991
|
+
}[];
|
|
992
|
+
}
|
|
993
|
+
interface FederatedAutocompleteResponseNonNullableFields {
|
|
994
|
+
results: {
|
|
995
|
+
values: {
|
|
996
|
+
query: string;
|
|
997
|
+
}[];
|
|
998
|
+
}[];
|
|
999
|
+
}
|
|
1000
|
+
interface TrendingResponseNonNullableFields {
|
|
1001
|
+
results: {
|
|
1002
|
+
documentType: string;
|
|
1003
|
+
}[];
|
|
1004
|
+
}
|
|
980
1005
|
interface SearchOptions {
|
|
981
1006
|
/** Text to search for. All searchable fields will be searched. */
|
|
982
1007
|
query?: string | null;
|
|
@@ -1005,17 +1030,138 @@ interface SearchOptions {
|
|
|
1005
1030
|
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1006
1031
|
includeSeoHidden?: boolean | null;
|
|
1007
1032
|
}
|
|
1033
|
+
interface FederatedSearchOptions {
|
|
1034
|
+
/** Query phrase to use. */
|
|
1035
|
+
query?: string | null;
|
|
1036
|
+
/** Language to search in. */
|
|
1037
|
+
language?: string | null;
|
|
1038
|
+
/** Limit of documents to return per document type. */
|
|
1039
|
+
limit?: number | null;
|
|
1040
|
+
/** Enable fuzzy search (for example query 'kalvin clein' will match document with 'calvin klein' in title). */
|
|
1041
|
+
fuzzy?: boolean | null;
|
|
1042
|
+
/** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
|
|
1043
|
+
highlight?: boolean | null;
|
|
1044
|
+
/** Searchable fields to search in. If not provided, search is executed on all searchable fields in schemas */
|
|
1045
|
+
searchFields?: string[];
|
|
1046
|
+
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
1047
|
+
documentTypes?: string[];
|
|
1048
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1049
|
+
includeSeoHidden?: boolean | null;
|
|
1050
|
+
}
|
|
1051
|
+
interface SuggestOptions {
|
|
1052
|
+
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
1053
|
+
query?: string | null;
|
|
1054
|
+
/** Document type of documents to search for. All document types are searched if not provided. */
|
|
1055
|
+
documentType?: string | null;
|
|
1056
|
+
/** Fields to order by. */
|
|
1057
|
+
ordering?: OrderingClauses;
|
|
1058
|
+
/** Number of suggested document to return. */
|
|
1059
|
+
limit?: number;
|
|
1060
|
+
/** Language to search in. */
|
|
1061
|
+
language?: string | null;
|
|
1062
|
+
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
|
|
1063
|
+
filter?: Record<string, any> | null;
|
|
1064
|
+
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schema */
|
|
1065
|
+
searchFields?: string[];
|
|
1066
|
+
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
1067
|
+
fields?: string[];
|
|
1068
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1069
|
+
includeSeoHidden?: boolean | null;
|
|
1070
|
+
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
|
|
1071
|
+
properties?: SearchProperty[];
|
|
1072
|
+
}
|
|
1073
|
+
interface FederatedSuggestOptions {
|
|
1074
|
+
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
1075
|
+
query?: string | null;
|
|
1076
|
+
/** Language to search in. */
|
|
1077
|
+
language?: string | null;
|
|
1078
|
+
/** Number of suggested document to return per document type. */
|
|
1079
|
+
limit?: number;
|
|
1080
|
+
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schemas */
|
|
1081
|
+
searchFields?: string[];
|
|
1082
|
+
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
1083
|
+
documentTypes?: string[];
|
|
1084
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1085
|
+
includeSeoHidden?: boolean | null;
|
|
1086
|
+
}
|
|
1087
|
+
interface RelatedOptions {
|
|
1088
|
+
/** ID of the document to fetch related documents for. */
|
|
1089
|
+
documentId?: string | null;
|
|
1090
|
+
/** Document type of the document. */
|
|
1091
|
+
documentType?: string | null;
|
|
1092
|
+
/** Fields to order by. */
|
|
1093
|
+
ordering?: OrderingClauses;
|
|
1094
|
+
/** Language to search in. */
|
|
1095
|
+
language?: string | null;
|
|
1096
|
+
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}). */
|
|
1097
|
+
filter?: Record<string, any> | null;
|
|
1098
|
+
/** Searchable fields to compare documents by. If not provided, all searchable fields in schema are used */
|
|
1099
|
+
searchFields?: string[];
|
|
1100
|
+
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
1101
|
+
fields?: string[];
|
|
1102
|
+
/** Number of related documents to return */
|
|
1103
|
+
limit?: number;
|
|
1104
|
+
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
|
|
1105
|
+
properties?: SearchProperty[];
|
|
1106
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1107
|
+
includeSeoHidden?: boolean | null;
|
|
1108
|
+
}
|
|
1109
|
+
interface AutocompleteOptions {
|
|
1110
|
+
/** Query phrase to fetch completions for. */
|
|
1111
|
+
query?: string | null;
|
|
1112
|
+
/** Document type to use to search for phrases. */
|
|
1113
|
+
documentType?: string | null;
|
|
1114
|
+
/** Limit of phrases to fetch. */
|
|
1115
|
+
limit?: number;
|
|
1116
|
+
/** Language to search in. */
|
|
1117
|
+
language?: string | null;
|
|
1118
|
+
/** Filter in platfromized query language (for example {'field': {'$eq': 'value'}}) */
|
|
1119
|
+
filter?: Record<string, any> | null;
|
|
1120
|
+
/** Searchable fields to use for query completion. If not provided, all searchable fields in schema are used */
|
|
1121
|
+
searchFields?: string[];
|
|
1122
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1123
|
+
includeSeoHidden?: boolean | null;
|
|
1124
|
+
}
|
|
1125
|
+
interface FederatedAutocompleteOptions {
|
|
1126
|
+
/** Query phrase to fetch completions for. */
|
|
1127
|
+
query?: string | null;
|
|
1128
|
+
/** Language to search in. */
|
|
1129
|
+
language?: string | null;
|
|
1130
|
+
/** Number of queries to return per document type. */
|
|
1131
|
+
limit?: number;
|
|
1132
|
+
/** Searchable fields to search in. If not provided, search is executed on all autocompletable fields in schemas */
|
|
1133
|
+
searchFields?: string[];
|
|
1134
|
+
/** Document types to autocomplete in. If not provided, autocomplete is executed on all document types enabled for the site */
|
|
1135
|
+
documentTypes?: string[];
|
|
1136
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1137
|
+
includeSeoHidden?: boolean | null;
|
|
1138
|
+
}
|
|
1139
|
+
interface TrendingOptions {
|
|
1140
|
+
documentTypes?: string[];
|
|
1141
|
+
language?: string | null;
|
|
1142
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1143
|
+
includeSeoHidden?: boolean | null;
|
|
1144
|
+
}
|
|
1008
1145
|
|
|
1009
1146
|
declare const __metadata: {
|
|
1010
1147
|
PACKAGE_NAME: string;
|
|
1011
1148
|
};
|
|
1012
1149
|
declare function search(httpClient: HttpClient): (options?: SearchOptions) => Promise<SearchResponse & SearchResponseNonNullableFields>;
|
|
1150
|
+
declare function federatedSearch(httpClient: HttpClient): (options?: FederatedSearchOptions) => Promise<FederatedSearchResponse & FederatedSearchResponseNonNullableFields>;
|
|
1151
|
+
declare function suggest(httpClient: HttpClient): (options?: SuggestOptions) => Promise<SuggestResponse>;
|
|
1152
|
+
declare function federatedSuggest(httpClient: HttpClient): (options?: FederatedSuggestOptions) => Promise<FederatedSuggestResponse & FederatedSuggestResponseNonNullableFields>;
|
|
1153
|
+
declare function related(httpClient: HttpClient): (options?: RelatedOptions) => Promise<RelatedResponse>;
|
|
1154
|
+
declare function autocomplete(httpClient: HttpClient): (options?: AutocompleteOptions) => Promise<AutocompleteResponse & AutocompleteResponseNonNullableFields>;
|
|
1155
|
+
declare function federatedAutocomplete(httpClient: HttpClient): (options?: FederatedAutocompleteOptions) => Promise<FederatedAutocompleteResponse & FederatedAutocompleteResponseNonNullableFields>;
|
|
1156
|
+
declare function trending(httpClient: HttpClient): (options?: TrendingOptions) => Promise<TrendingResponse & TrendingResponseNonNullableFields>;
|
|
1013
1157
|
|
|
1014
1158
|
type index_d_Aggregation = Aggregation;
|
|
1015
1159
|
declare const index_d_Aggregation: typeof Aggregation;
|
|
1016
1160
|
type index_d_AggregationFacet = AggregationFacet;
|
|
1161
|
+
type index_d_AutocompleteOptions = AutocompleteOptions;
|
|
1017
1162
|
type index_d_AutocompleteRequest = AutocompleteRequest;
|
|
1018
1163
|
type index_d_AutocompleteResponse = AutocompleteResponse;
|
|
1164
|
+
type index_d_AutocompleteResponseNonNullableFields = AutocompleteResponseNonNullableFields;
|
|
1019
1165
|
type index_d_AutocompleteResponseValue = AutocompleteResponseValue;
|
|
1020
1166
|
type index_d_DeleteByFilterOperation = DeleteByFilterOperation;
|
|
1021
1167
|
type index_d_DeleteByIdsOperation = DeleteByIdsOperation;
|
|
@@ -1033,15 +1179,21 @@ type index_d_FacetClauses = FacetClauses;
|
|
|
1033
1179
|
type index_d_FacetCountResponse = FacetCountResponse;
|
|
1034
1180
|
type index_d_FacetsResponse = FacetsResponse;
|
|
1035
1181
|
type index_d_FacetsResponseResponseOneOf = FacetsResponseResponseOneOf;
|
|
1182
|
+
type index_d_FederatedAutocompleteOptions = FederatedAutocompleteOptions;
|
|
1036
1183
|
type index_d_FederatedAutocompleteRequest = FederatedAutocompleteRequest;
|
|
1037
1184
|
type index_d_FederatedAutocompleteResponse = FederatedAutocompleteResponse;
|
|
1185
|
+
type index_d_FederatedAutocompleteResponseNonNullableFields = FederatedAutocompleteResponseNonNullableFields;
|
|
1038
1186
|
type index_d_FederatedAutocompleteResults = FederatedAutocompleteResults;
|
|
1039
1187
|
type index_d_FederatedSearchDocuments = FederatedSearchDocuments;
|
|
1188
|
+
type index_d_FederatedSearchOptions = FederatedSearchOptions;
|
|
1040
1189
|
type index_d_FederatedSearchRequest = FederatedSearchRequest;
|
|
1041
1190
|
type index_d_FederatedSearchResponse = FederatedSearchResponse;
|
|
1191
|
+
type index_d_FederatedSearchResponseNonNullableFields = FederatedSearchResponseNonNullableFields;
|
|
1042
1192
|
type index_d_FederatedSuggestDocuments = FederatedSuggestDocuments;
|
|
1193
|
+
type index_d_FederatedSuggestOptions = FederatedSuggestOptions;
|
|
1043
1194
|
type index_d_FederatedSuggestRequest = FederatedSuggestRequest;
|
|
1044
1195
|
type index_d_FederatedSuggestResponse = FederatedSuggestResponse;
|
|
1196
|
+
type index_d_FederatedSuggestResponseNonNullableFields = FederatedSuggestResponseNonNullableFields;
|
|
1045
1197
|
type index_d_HierarchicalAggregationResponse = HierarchicalAggregationResponse;
|
|
1046
1198
|
type index_d_HierarchicalFacet = HierarchicalFacet;
|
|
1047
1199
|
type index_d_HierarchicalFacetClauseOneOf = HierarchicalFacetClauseOneOf;
|
|
@@ -1059,6 +1211,7 @@ type index_d_MinMaxAggregationResponse = MinMaxAggregationResponse;
|
|
|
1059
1211
|
type index_d_NextPageResponse = NextPageResponse;
|
|
1060
1212
|
type index_d_OrderingClause = OrderingClause;
|
|
1061
1213
|
type index_d_OrderingClauses = OrderingClauses;
|
|
1214
|
+
type index_d_RelatedOptions = RelatedOptions;
|
|
1062
1215
|
type index_d_RelatedRequest = RelatedRequest;
|
|
1063
1216
|
type index_d_RelatedResponse = RelatedResponse;
|
|
1064
1217
|
type index_d_SearchOptions = SearchOptions;
|
|
@@ -1068,14 +1221,17 @@ type index_d_SearchRequest = SearchRequest;
|
|
|
1068
1221
|
type index_d_SearchResponse = SearchResponse;
|
|
1069
1222
|
type index_d_SearchResponseNonNullableFields = SearchResponseNonNullableFields;
|
|
1070
1223
|
type index_d_SiteDocument = SiteDocument;
|
|
1224
|
+
type index_d_SuggestOptions = SuggestOptions;
|
|
1071
1225
|
type index_d_SuggestRequest = SuggestRequest;
|
|
1072
1226
|
type index_d_SuggestResponse = SuggestResponse;
|
|
1073
1227
|
type index_d_SumAggregationResponse = SumAggregationResponse;
|
|
1074
1228
|
type index_d_TermAggregationResponse = TermAggregationResponse;
|
|
1075
1229
|
type index_d_TermFacet = TermFacet;
|
|
1076
1230
|
type index_d_TrendingItems = TrendingItems;
|
|
1231
|
+
type index_d_TrendingOptions = TrendingOptions;
|
|
1077
1232
|
type index_d_TrendingRequest = TrendingRequest;
|
|
1078
1233
|
type index_d_TrendingResponse = TrendingResponse;
|
|
1234
|
+
type index_d_TrendingResponseNonNullableFields = TrendingResponseNonNullableFields;
|
|
1079
1235
|
type index_d_UpdateByFilterOperation = UpdateByFilterOperation;
|
|
1080
1236
|
type index_d_UpdateDocumentsEvent = UpdateDocumentsEvent;
|
|
1081
1237
|
type index_d_UpdateDocumentsEventOperationOneOf = UpdateDocumentsEventOperationOneOf;
|
|
@@ -1093,9 +1249,16 @@ declare const index_d_VersioningMode: typeof VersioningMode;
|
|
|
1093
1249
|
type index_d_WebhookIdentityType = WebhookIdentityType;
|
|
1094
1250
|
declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
|
|
1095
1251
|
declare const index_d___metadata: typeof __metadata;
|
|
1252
|
+
declare const index_d_autocomplete: typeof autocomplete;
|
|
1253
|
+
declare const index_d_federatedAutocomplete: typeof federatedAutocomplete;
|
|
1254
|
+
declare const index_d_federatedSearch: typeof federatedSearch;
|
|
1255
|
+
declare const index_d_federatedSuggest: typeof federatedSuggest;
|
|
1256
|
+
declare const index_d_related: typeof related;
|
|
1096
1257
|
declare const index_d_search: typeof search;
|
|
1258
|
+
declare const index_d_suggest: typeof suggest;
|
|
1259
|
+
declare const index_d_trending: typeof trending;
|
|
1097
1260
|
declare namespace index_d {
|
|
1098
|
-
export { index_d_Aggregation as Aggregation, type index_d_AggregationFacet as AggregationFacet, type index_d_AutocompleteRequest as AutocompleteRequest, type index_d_AutocompleteResponse as AutocompleteResponse, type index_d_AutocompleteResponseValue as AutocompleteResponseValue, type index_d_DeleteByFilterOperation as DeleteByFilterOperation, type index_d_DeleteByIdsOperation as DeleteByIdsOperation, index_d_Direction as Direction, type index_d_DocumentImage as DocumentImage, type index_d_DocumentPayload as DocumentPayload, type index_d_DocumentUpdateOperation as DocumentUpdateOperation, type index_d_Empty as Empty, index_d_Enum as Enum, type index_d_FacetClause as FacetClause, type index_d_FacetClauseClauseOneOf as FacetClauseClauseOneOf, type index_d_FacetClauses as FacetClauses, type index_d_FacetCountResponse as FacetCountResponse, type index_d_FacetsResponse as FacetsResponse, type index_d_FacetsResponseResponseOneOf as FacetsResponseResponseOneOf, type index_d_FederatedAutocompleteRequest as FederatedAutocompleteRequest, type index_d_FederatedAutocompleteResponse as FederatedAutocompleteResponse, type index_d_FederatedAutocompleteResults as FederatedAutocompleteResults, type index_d_FederatedSearchDocuments as FederatedSearchDocuments, type index_d_FederatedSearchRequest as FederatedSearchRequest, type index_d_FederatedSearchResponse as FederatedSearchResponse, type index_d_FederatedSuggestDocuments as FederatedSuggestDocuments, type index_d_FederatedSuggestRequest as FederatedSuggestRequest, type index_d_FederatedSuggestResponse as FederatedSuggestResponse, type index_d_HierarchicalAggregationResponse as HierarchicalAggregationResponse, type index_d_HierarchicalFacet as HierarchicalFacet, type index_d_HierarchicalFacetClauseOneOf as HierarchicalFacetClauseOneOf, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_IndexDocument as IndexDocument, type index_d_InternalDocument as InternalDocument, type index_d_InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperation, type index_d_InternalDocumentUpdateOperation as InternalDocumentUpdateOperation, type index_d_InternalUpdateExistingOperation as InternalUpdateExistingOperation, type index_d_MaxAggregationResponse as MaxAggregationResponse, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MinAggregationResponse as MinAggregationResponse, type index_d_MinMaxAggregationResponse as MinMaxAggregationResponse, type index_d_NextPageResponse as NextPageResponse, type index_d_OrderingClause as OrderingClause, type index_d_OrderingClauses as OrderingClauses, type index_d_RelatedRequest as RelatedRequest, type index_d_RelatedResponse as RelatedResponse, type index_d_SearchOptions as SearchOptions, type index_d_SearchPaging as SearchPaging, type index_d_SearchProperty as SearchProperty, type index_d_SearchRequest as SearchRequest, type index_d_SearchResponse as SearchResponse, type index_d_SearchResponseNonNullableFields as SearchResponseNonNullableFields, type index_d_SiteDocument as SiteDocument, type index_d_SuggestRequest as SuggestRequest, type index_d_SuggestResponse as SuggestResponse, type index_d_SumAggregationResponse as SumAggregationResponse, type index_d_TermAggregationResponse as TermAggregationResponse, type index_d_TermFacet as TermFacet, type index_d_TrendingItems as TrendingItems, type index_d_TrendingRequest as TrendingRequest, type index_d_TrendingResponse as TrendingResponse, type index_d_UpdateByFilterOperation as UpdateByFilterOperation, type index_d_UpdateDocumentsEvent as UpdateDocumentsEvent, type index_d_UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOf, type index_d_UpdateExistingOperation as UpdateExistingOperation, type index_d_UpdateInternalDocumentsEvent as UpdateInternalDocumentsEvent, type index_d_UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOf, type index_d_V1DeleteByFilterOperation as V1DeleteByFilterOperation, type index_d_V1DeleteByIdsOperation as V1DeleteByIdsOperation, type index_d_Value as Value, type index_d_VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperation, type index_d_VersionedDocumentId as VersionedDocumentId, type index_d_VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperation, index_d_VersioningMode as VersioningMode, index_d_WebhookIdentityType as WebhookIdentityType, index_d___metadata as __metadata, index_d_search as search };
|
|
1261
|
+
export { index_d_Aggregation as Aggregation, type index_d_AggregationFacet as AggregationFacet, type index_d_AutocompleteOptions as AutocompleteOptions, type index_d_AutocompleteRequest as AutocompleteRequest, type index_d_AutocompleteResponse as AutocompleteResponse, type index_d_AutocompleteResponseNonNullableFields as AutocompleteResponseNonNullableFields, type index_d_AutocompleteResponseValue as AutocompleteResponseValue, type index_d_DeleteByFilterOperation as DeleteByFilterOperation, type index_d_DeleteByIdsOperation as DeleteByIdsOperation, index_d_Direction as Direction, type index_d_DocumentImage as DocumentImage, type index_d_DocumentPayload as DocumentPayload, type index_d_DocumentUpdateOperation as DocumentUpdateOperation, type index_d_Empty as Empty, index_d_Enum as Enum, type index_d_FacetClause as FacetClause, type index_d_FacetClauseClauseOneOf as FacetClauseClauseOneOf, type index_d_FacetClauses as FacetClauses, type index_d_FacetCountResponse as FacetCountResponse, type index_d_FacetsResponse as FacetsResponse, type index_d_FacetsResponseResponseOneOf as FacetsResponseResponseOneOf, type index_d_FederatedAutocompleteOptions as FederatedAutocompleteOptions, type index_d_FederatedAutocompleteRequest as FederatedAutocompleteRequest, type index_d_FederatedAutocompleteResponse as FederatedAutocompleteResponse, type index_d_FederatedAutocompleteResponseNonNullableFields as FederatedAutocompleteResponseNonNullableFields, type index_d_FederatedAutocompleteResults as FederatedAutocompleteResults, type index_d_FederatedSearchDocuments as FederatedSearchDocuments, type index_d_FederatedSearchOptions as FederatedSearchOptions, type index_d_FederatedSearchRequest as FederatedSearchRequest, type index_d_FederatedSearchResponse as FederatedSearchResponse, type index_d_FederatedSearchResponseNonNullableFields as FederatedSearchResponseNonNullableFields, type index_d_FederatedSuggestDocuments as FederatedSuggestDocuments, type index_d_FederatedSuggestOptions as FederatedSuggestOptions, type index_d_FederatedSuggestRequest as FederatedSuggestRequest, type index_d_FederatedSuggestResponse as FederatedSuggestResponse, type index_d_FederatedSuggestResponseNonNullableFields as FederatedSuggestResponseNonNullableFields, type index_d_HierarchicalAggregationResponse as HierarchicalAggregationResponse, type index_d_HierarchicalFacet as HierarchicalFacet, type index_d_HierarchicalFacetClauseOneOf as HierarchicalFacetClauseOneOf, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_IndexDocument as IndexDocument, type index_d_InternalDocument as InternalDocument, type index_d_InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperation, type index_d_InternalDocumentUpdateOperation as InternalDocumentUpdateOperation, type index_d_InternalUpdateExistingOperation as InternalUpdateExistingOperation, type index_d_MaxAggregationResponse as MaxAggregationResponse, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MinAggregationResponse as MinAggregationResponse, type index_d_MinMaxAggregationResponse as MinMaxAggregationResponse, type index_d_NextPageResponse as NextPageResponse, type index_d_OrderingClause as OrderingClause, type index_d_OrderingClauses as OrderingClauses, type index_d_RelatedOptions as RelatedOptions, type index_d_RelatedRequest as RelatedRequest, type index_d_RelatedResponse as RelatedResponse, type index_d_SearchOptions as SearchOptions, type index_d_SearchPaging as SearchPaging, type index_d_SearchProperty as SearchProperty, type index_d_SearchRequest as SearchRequest, type index_d_SearchResponse as SearchResponse, type index_d_SearchResponseNonNullableFields as SearchResponseNonNullableFields, type index_d_SiteDocument as SiteDocument, type index_d_SuggestOptions as SuggestOptions, type index_d_SuggestRequest as SuggestRequest, type index_d_SuggestResponse as SuggestResponse, type index_d_SumAggregationResponse as SumAggregationResponse, type index_d_TermAggregationResponse as TermAggregationResponse, type index_d_TermFacet as TermFacet, type index_d_TrendingItems as TrendingItems, type index_d_TrendingOptions as TrendingOptions, type index_d_TrendingRequest as TrendingRequest, type index_d_TrendingResponse as TrendingResponse, type index_d_TrendingResponseNonNullableFields as TrendingResponseNonNullableFields, type index_d_UpdateByFilterOperation as UpdateByFilterOperation, type index_d_UpdateDocumentsEvent as UpdateDocumentsEvent, type index_d_UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOf, type index_d_UpdateExistingOperation as UpdateExistingOperation, type index_d_UpdateInternalDocumentsEvent as UpdateInternalDocumentsEvent, type index_d_UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOf, type index_d_V1DeleteByFilterOperation as V1DeleteByFilterOperation, type index_d_V1DeleteByIdsOperation as V1DeleteByIdsOperation, type index_d_Value as Value, type index_d_VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperation, type index_d_VersionedDocumentId as VersionedDocumentId, type index_d_VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperation, index_d_VersioningMode as VersioningMode, index_d_WebhookIdentityType as WebhookIdentityType, index_d___metadata as __metadata, index_d_autocomplete as autocomplete, index_d_federatedAutocomplete as federatedAutocomplete, index_d_federatedSearch as federatedSearch, index_d_federatedSuggest as federatedSuggest, index_d_related as related, index_d_search as search, index_d_suggest as suggest, index_d_trending as trending };
|
|
1099
1262
|
}
|
|
1100
1263
|
|
|
1101
1264
|
export { index_d as siteSearch, index_d$1 as wixSiteSearch };
|
|
@@ -753,6 +753,173 @@ interface SumAggregationResponse$1 {
|
|
|
753
753
|
/** The sum value across all documents */
|
|
754
754
|
value?: number | null;
|
|
755
755
|
}
|
|
756
|
+
interface FederatedSearchRequest$1 {
|
|
757
|
+
/** Query phrase to use. */
|
|
758
|
+
query?: string | null;
|
|
759
|
+
/** Language to search in. */
|
|
760
|
+
language?: string | null;
|
|
761
|
+
/** Limit of documents to return per document type. */
|
|
762
|
+
limit?: number | null;
|
|
763
|
+
/** Enable fuzzy search (for example query 'kalvin clein' will match document with 'calvin klein' in title). */
|
|
764
|
+
fuzzy?: boolean | null;
|
|
765
|
+
/** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
|
|
766
|
+
highlight?: boolean | null;
|
|
767
|
+
/** Searchable fields to search in. If not provided, search is executed on all searchable fields in schemas */
|
|
768
|
+
searchFields?: string[];
|
|
769
|
+
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
770
|
+
documentTypes?: string[];
|
|
771
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
772
|
+
includeSeoHidden?: boolean | null;
|
|
773
|
+
}
|
|
774
|
+
interface FederatedSearchResponse$1 {
|
|
775
|
+
/** Search results from multiple indexes. */
|
|
776
|
+
results?: FederatedSearchDocuments$1[];
|
|
777
|
+
}
|
|
778
|
+
interface FederatedSearchDocuments$1 {
|
|
779
|
+
/** Document type of documents */
|
|
780
|
+
documentType?: string | null;
|
|
781
|
+
/** Documents of document type */
|
|
782
|
+
documents?: Record<string, any>[] | null;
|
|
783
|
+
/** Total count of matching documents for document type */
|
|
784
|
+
total?: number;
|
|
785
|
+
}
|
|
786
|
+
interface SuggestRequest$1 {
|
|
787
|
+
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
788
|
+
query?: string | null;
|
|
789
|
+
/** Document type of documents to search for. All document types are searched if not provided. */
|
|
790
|
+
documentType?: string | null;
|
|
791
|
+
/** Fields to order by. */
|
|
792
|
+
ordering?: OrderingClauses$1;
|
|
793
|
+
/** Number of suggested document to return. */
|
|
794
|
+
limit?: number;
|
|
795
|
+
/** Language to search in. */
|
|
796
|
+
language?: string | null;
|
|
797
|
+
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
|
|
798
|
+
filter?: Record<string, any> | null;
|
|
799
|
+
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schema */
|
|
800
|
+
searchFields?: string[];
|
|
801
|
+
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
802
|
+
fields?: string[];
|
|
803
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
804
|
+
includeSeoHidden?: boolean | null;
|
|
805
|
+
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
|
|
806
|
+
properties?: SearchProperty$1[];
|
|
807
|
+
}
|
|
808
|
+
interface SuggestResponse$1 {
|
|
809
|
+
/** Suggested documents. */
|
|
810
|
+
documents?: Record<string, any>[] | null;
|
|
811
|
+
}
|
|
812
|
+
interface FederatedSuggestRequest$1 {
|
|
813
|
+
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
814
|
+
query?: string | null;
|
|
815
|
+
/** Language to search in. */
|
|
816
|
+
language?: string | null;
|
|
817
|
+
/** Number of suggested document to return per document type. */
|
|
818
|
+
limit?: number;
|
|
819
|
+
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schemas */
|
|
820
|
+
searchFields?: string[];
|
|
821
|
+
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
822
|
+
documentTypes?: string[];
|
|
823
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
824
|
+
includeSeoHidden?: boolean | null;
|
|
825
|
+
}
|
|
826
|
+
interface FederatedSuggestResponse$1 {
|
|
827
|
+
/** Suggest results from multiple indexes. */
|
|
828
|
+
results?: FederatedSuggestDocuments$1[];
|
|
829
|
+
}
|
|
830
|
+
interface FederatedSuggestDocuments$1 {
|
|
831
|
+
/** Document type of documents */
|
|
832
|
+
documentType?: string | null;
|
|
833
|
+
/** Documents of document type */
|
|
834
|
+
documents?: Record<string, any>[] | null;
|
|
835
|
+
}
|
|
836
|
+
interface RelatedRequest$1 {
|
|
837
|
+
/** ID of the document to fetch related documents for. */
|
|
838
|
+
documentId?: string | null;
|
|
839
|
+
/** Document type of the document. */
|
|
840
|
+
documentType?: string | null;
|
|
841
|
+
/** Fields to order by. */
|
|
842
|
+
ordering?: OrderingClauses$1;
|
|
843
|
+
/** Language to search in. */
|
|
844
|
+
language?: string | null;
|
|
845
|
+
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}). */
|
|
846
|
+
filter?: Record<string, any> | null;
|
|
847
|
+
/** Searchable fields to compare documents by. If not provided, all searchable fields in schema are used */
|
|
848
|
+
searchFields?: string[];
|
|
849
|
+
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
850
|
+
fields?: string[];
|
|
851
|
+
/** Number of related documents to return */
|
|
852
|
+
limit?: number;
|
|
853
|
+
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
|
|
854
|
+
properties?: SearchProperty$1[];
|
|
855
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
856
|
+
includeSeoHidden?: boolean | null;
|
|
857
|
+
}
|
|
858
|
+
interface RelatedResponse$1 {
|
|
859
|
+
/** Documents matching filter and query. */
|
|
860
|
+
documents?: Record<string, any>[] | null;
|
|
861
|
+
}
|
|
862
|
+
interface AutocompleteRequest$1 {
|
|
863
|
+
/** Query phrase to fetch completions for. */
|
|
864
|
+
query?: string | null;
|
|
865
|
+
/** Document type to use to search for phrases. */
|
|
866
|
+
documentType?: string | null;
|
|
867
|
+
/** Limit of phrases to fetch. */
|
|
868
|
+
limit?: number;
|
|
869
|
+
/** Language to search in. */
|
|
870
|
+
language?: string | null;
|
|
871
|
+
/** Filter in platfromized query language (for example {'field': {'$eq': 'value'}}) */
|
|
872
|
+
filter?: Record<string, any> | null;
|
|
873
|
+
/** Searchable fields to use for query completion. If not provided, all searchable fields in schema are used */
|
|
874
|
+
searchFields?: string[];
|
|
875
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
876
|
+
includeSeoHidden?: boolean | null;
|
|
877
|
+
}
|
|
878
|
+
interface AutocompleteResponse$1 {
|
|
879
|
+
/** Suggested phrases. */
|
|
880
|
+
values?: AutocompleteResponseValue$1[];
|
|
881
|
+
}
|
|
882
|
+
interface AutocompleteResponseValue$1 {
|
|
883
|
+
/** Suggested phrase. */
|
|
884
|
+
query?: string;
|
|
885
|
+
}
|
|
886
|
+
interface FederatedAutocompleteRequest$1 {
|
|
887
|
+
/** Query phrase to fetch completions for. */
|
|
888
|
+
query?: string | null;
|
|
889
|
+
/** Language to search in. */
|
|
890
|
+
language?: string | null;
|
|
891
|
+
/** Number of queries to return per document type. */
|
|
892
|
+
limit?: number;
|
|
893
|
+
/** Searchable fields to search in. If not provided, search is executed on all autocompletable fields in schemas */
|
|
894
|
+
searchFields?: string[];
|
|
895
|
+
/** Document types to autocomplete in. If not provided, autocomplete is executed on all document types enabled for the site */
|
|
896
|
+
documentTypes?: string[];
|
|
897
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
898
|
+
includeSeoHidden?: boolean | null;
|
|
899
|
+
}
|
|
900
|
+
interface FederatedAutocompleteResponse$1 {
|
|
901
|
+
/** Suggested phrases from multiple indexes */
|
|
902
|
+
results?: FederatedAutocompleteResults$1[];
|
|
903
|
+
}
|
|
904
|
+
interface FederatedAutocompleteResults$1 {
|
|
905
|
+
/** Document type of queries */
|
|
906
|
+
documentType?: string | null;
|
|
907
|
+
/** Suggested phrases */
|
|
908
|
+
values?: AutocompleteResponseValue$1[];
|
|
909
|
+
}
|
|
910
|
+
interface TrendingRequest$1 {
|
|
911
|
+
documentTypes?: string[];
|
|
912
|
+
language?: string | null;
|
|
913
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
914
|
+
includeSeoHidden?: boolean | null;
|
|
915
|
+
}
|
|
916
|
+
interface TrendingResponse$1 {
|
|
917
|
+
results?: TrendingItems$1[];
|
|
918
|
+
}
|
|
919
|
+
interface TrendingItems$1 {
|
|
920
|
+
documentType?: string;
|
|
921
|
+
documents?: Record<string, any>[] | null;
|
|
922
|
+
}
|
|
756
923
|
interface SearchResponseNonNullableFields$1 {
|
|
757
924
|
nextPage?: {
|
|
758
925
|
total: number;
|
|
@@ -788,6 +955,31 @@ interface SearchResponseNonNullableFields$1 {
|
|
|
788
955
|
};
|
|
789
956
|
}[];
|
|
790
957
|
}
|
|
958
|
+
interface FederatedSearchResponseNonNullableFields$1 {
|
|
959
|
+
results: {
|
|
960
|
+
total: number;
|
|
961
|
+
}[];
|
|
962
|
+
}
|
|
963
|
+
interface FederatedSuggestResponseNonNullableFields$1 {
|
|
964
|
+
results: FederatedSuggestDocuments$1[];
|
|
965
|
+
}
|
|
966
|
+
interface AutocompleteResponseNonNullableFields$1 {
|
|
967
|
+
values: {
|
|
968
|
+
query: string;
|
|
969
|
+
}[];
|
|
970
|
+
}
|
|
971
|
+
interface FederatedAutocompleteResponseNonNullableFields$1 {
|
|
972
|
+
results: {
|
|
973
|
+
values: {
|
|
974
|
+
query: string;
|
|
975
|
+
}[];
|
|
976
|
+
}[];
|
|
977
|
+
}
|
|
978
|
+
interface TrendingResponseNonNullableFields$1 {
|
|
979
|
+
results: {
|
|
980
|
+
documentType: string;
|
|
981
|
+
}[];
|
|
982
|
+
}
|
|
791
983
|
|
|
792
984
|
interface SearchRequest {
|
|
793
985
|
/** Text to search for. All searchable fields will be searched. */
|
|
@@ -968,6 +1160,173 @@ interface SumAggregationResponse {
|
|
|
968
1160
|
/** The sum value across all documents */
|
|
969
1161
|
value?: number | null;
|
|
970
1162
|
}
|
|
1163
|
+
interface FederatedSearchRequest {
|
|
1164
|
+
/** Query phrase to use. */
|
|
1165
|
+
query?: string | null;
|
|
1166
|
+
/** Language to search in. */
|
|
1167
|
+
language?: string | null;
|
|
1168
|
+
/** Limit of documents to return per document type. */
|
|
1169
|
+
limit?: number | null;
|
|
1170
|
+
/** Enable fuzzy search (for example query 'kalvin clein' will match document with 'calvin klein' in title). */
|
|
1171
|
+
fuzzy?: boolean | null;
|
|
1172
|
+
/** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
|
|
1173
|
+
highlight?: boolean | null;
|
|
1174
|
+
/** Searchable fields to search in. If not provided, search is executed on all searchable fields in schemas */
|
|
1175
|
+
searchFields?: string[];
|
|
1176
|
+
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
1177
|
+
documentTypes?: string[];
|
|
1178
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1179
|
+
includeSeoHidden?: boolean | null;
|
|
1180
|
+
}
|
|
1181
|
+
interface FederatedSearchResponse {
|
|
1182
|
+
/** Search results from multiple indexes. */
|
|
1183
|
+
results?: FederatedSearchDocuments[];
|
|
1184
|
+
}
|
|
1185
|
+
interface FederatedSearchDocuments {
|
|
1186
|
+
/** Document type of documents */
|
|
1187
|
+
documentType?: string | null;
|
|
1188
|
+
/** Documents of document type */
|
|
1189
|
+
documents?: Record<string, any>[] | null;
|
|
1190
|
+
/** Total count of matching documents for document type */
|
|
1191
|
+
total?: number;
|
|
1192
|
+
}
|
|
1193
|
+
interface SuggestRequest {
|
|
1194
|
+
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
1195
|
+
query?: string | null;
|
|
1196
|
+
/** Document type of documents to search for. All document types are searched if not provided. */
|
|
1197
|
+
documentType?: string | null;
|
|
1198
|
+
/** Fields to order by. */
|
|
1199
|
+
ordering?: OrderingClauses;
|
|
1200
|
+
/** Number of suggested document to return. */
|
|
1201
|
+
limit?: number;
|
|
1202
|
+
/** Language to search in. */
|
|
1203
|
+
language?: string | null;
|
|
1204
|
+
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
|
|
1205
|
+
filter?: Record<string, any> | null;
|
|
1206
|
+
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schema */
|
|
1207
|
+
searchFields?: string[];
|
|
1208
|
+
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
1209
|
+
fields?: string[];
|
|
1210
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1211
|
+
includeSeoHidden?: boolean | null;
|
|
1212
|
+
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
|
|
1213
|
+
properties?: SearchProperty[];
|
|
1214
|
+
}
|
|
1215
|
+
interface SuggestResponse {
|
|
1216
|
+
/** Suggested documents. */
|
|
1217
|
+
documents?: Record<string, any>[] | null;
|
|
1218
|
+
}
|
|
1219
|
+
interface FederatedSuggestRequest {
|
|
1220
|
+
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
1221
|
+
query?: string | null;
|
|
1222
|
+
/** Language to search in. */
|
|
1223
|
+
language?: string | null;
|
|
1224
|
+
/** Number of suggested document to return per document type. */
|
|
1225
|
+
limit?: number;
|
|
1226
|
+
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schemas */
|
|
1227
|
+
searchFields?: string[];
|
|
1228
|
+
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
1229
|
+
documentTypes?: string[];
|
|
1230
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1231
|
+
includeSeoHidden?: boolean | null;
|
|
1232
|
+
}
|
|
1233
|
+
interface FederatedSuggestResponse {
|
|
1234
|
+
/** Suggest results from multiple indexes. */
|
|
1235
|
+
results?: FederatedSuggestDocuments[];
|
|
1236
|
+
}
|
|
1237
|
+
interface FederatedSuggestDocuments {
|
|
1238
|
+
/** Document type of documents */
|
|
1239
|
+
documentType?: string | null;
|
|
1240
|
+
/** Documents of document type */
|
|
1241
|
+
documents?: Record<string, any>[] | null;
|
|
1242
|
+
}
|
|
1243
|
+
interface RelatedRequest {
|
|
1244
|
+
/** ID of the document to fetch related documents for. */
|
|
1245
|
+
documentId?: string | null;
|
|
1246
|
+
/** Document type of the document. */
|
|
1247
|
+
documentType?: string | null;
|
|
1248
|
+
/** Fields to order by. */
|
|
1249
|
+
ordering?: OrderingClauses;
|
|
1250
|
+
/** Language to search in. */
|
|
1251
|
+
language?: string | null;
|
|
1252
|
+
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}). */
|
|
1253
|
+
filter?: Record<string, any> | null;
|
|
1254
|
+
/** Searchable fields to compare documents by. If not provided, all searchable fields in schema are used */
|
|
1255
|
+
searchFields?: string[];
|
|
1256
|
+
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
1257
|
+
fields?: string[];
|
|
1258
|
+
/** Number of related documents to return */
|
|
1259
|
+
limit?: number;
|
|
1260
|
+
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
|
|
1261
|
+
properties?: SearchProperty[];
|
|
1262
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1263
|
+
includeSeoHidden?: boolean | null;
|
|
1264
|
+
}
|
|
1265
|
+
interface RelatedResponse {
|
|
1266
|
+
/** Documents matching filter and query. */
|
|
1267
|
+
documents?: Record<string, any>[] | null;
|
|
1268
|
+
}
|
|
1269
|
+
interface AutocompleteRequest {
|
|
1270
|
+
/** Query phrase to fetch completions for. */
|
|
1271
|
+
query?: string | null;
|
|
1272
|
+
/** Document type to use to search for phrases. */
|
|
1273
|
+
documentType?: string | null;
|
|
1274
|
+
/** Limit of phrases to fetch. */
|
|
1275
|
+
limit?: number;
|
|
1276
|
+
/** Language to search in. */
|
|
1277
|
+
language?: string | null;
|
|
1278
|
+
/** Filter in platfromized query language (for example {'field': {'$eq': 'value'}}) */
|
|
1279
|
+
filter?: Record<string, any> | null;
|
|
1280
|
+
/** Searchable fields to use for query completion. If not provided, all searchable fields in schema are used */
|
|
1281
|
+
searchFields?: string[];
|
|
1282
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1283
|
+
includeSeoHidden?: boolean | null;
|
|
1284
|
+
}
|
|
1285
|
+
interface AutocompleteResponse {
|
|
1286
|
+
/** Suggested phrases. */
|
|
1287
|
+
values?: AutocompleteResponseValue[];
|
|
1288
|
+
}
|
|
1289
|
+
interface AutocompleteResponseValue {
|
|
1290
|
+
/** Suggested phrase. */
|
|
1291
|
+
query?: string;
|
|
1292
|
+
}
|
|
1293
|
+
interface FederatedAutocompleteRequest {
|
|
1294
|
+
/** Query phrase to fetch completions for. */
|
|
1295
|
+
query?: string | null;
|
|
1296
|
+
/** Language to search in. */
|
|
1297
|
+
language?: string | null;
|
|
1298
|
+
/** Number of queries to return per document type. */
|
|
1299
|
+
limit?: number;
|
|
1300
|
+
/** Searchable fields to search in. If not provided, search is executed on all autocompletable fields in schemas */
|
|
1301
|
+
searchFields?: string[];
|
|
1302
|
+
/** Document types to autocomplete in. If not provided, autocomplete is executed on all document types enabled for the site */
|
|
1303
|
+
documentTypes?: string[];
|
|
1304
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1305
|
+
includeSeoHidden?: boolean | null;
|
|
1306
|
+
}
|
|
1307
|
+
interface FederatedAutocompleteResponse {
|
|
1308
|
+
/** Suggested phrases from multiple indexes */
|
|
1309
|
+
results?: FederatedAutocompleteResults[];
|
|
1310
|
+
}
|
|
1311
|
+
interface FederatedAutocompleteResults {
|
|
1312
|
+
/** Document type of queries */
|
|
1313
|
+
documentType?: string | null;
|
|
1314
|
+
/** Suggested phrases */
|
|
1315
|
+
values?: AutocompleteResponseValue[];
|
|
1316
|
+
}
|
|
1317
|
+
interface TrendingRequest {
|
|
1318
|
+
documentTypes?: string[];
|
|
1319
|
+
language?: string | null;
|
|
1320
|
+
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1321
|
+
includeSeoHidden?: boolean | null;
|
|
1322
|
+
}
|
|
1323
|
+
interface TrendingResponse {
|
|
1324
|
+
results?: TrendingItems[];
|
|
1325
|
+
}
|
|
1326
|
+
interface TrendingItems {
|
|
1327
|
+
documentType?: string;
|
|
1328
|
+
documents?: Record<string, any>[] | null;
|
|
1329
|
+
}
|
|
971
1330
|
interface SearchResponseNonNullableFields {
|
|
972
1331
|
nextPage?: {
|
|
973
1332
|
total: number;
|
|
@@ -1003,6 +1362,31 @@ interface SearchResponseNonNullableFields {
|
|
|
1003
1362
|
};
|
|
1004
1363
|
}[];
|
|
1005
1364
|
}
|
|
1365
|
+
interface FederatedSearchResponseNonNullableFields {
|
|
1366
|
+
results: {
|
|
1367
|
+
total: number;
|
|
1368
|
+
}[];
|
|
1369
|
+
}
|
|
1370
|
+
interface FederatedSuggestResponseNonNullableFields {
|
|
1371
|
+
results: FederatedSuggestDocuments[];
|
|
1372
|
+
}
|
|
1373
|
+
interface AutocompleteResponseNonNullableFields {
|
|
1374
|
+
values: {
|
|
1375
|
+
query: string;
|
|
1376
|
+
}[];
|
|
1377
|
+
}
|
|
1378
|
+
interface FederatedAutocompleteResponseNonNullableFields {
|
|
1379
|
+
results: {
|
|
1380
|
+
values: {
|
|
1381
|
+
query: string;
|
|
1382
|
+
}[];
|
|
1383
|
+
}[];
|
|
1384
|
+
}
|
|
1385
|
+
interface TrendingResponseNonNullableFields {
|
|
1386
|
+
results: {
|
|
1387
|
+
documentType: string;
|
|
1388
|
+
}[];
|
|
1389
|
+
}
|
|
1006
1390
|
|
|
1007
1391
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1008
1392
|
getUrl: (context: any) => string;
|
|
@@ -1015,11 +1399,25 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
1015
1399
|
__originalResponseType: R;
|
|
1016
1400
|
};
|
|
1017
1401
|
declare function search(): __PublicMethodMetaInfo<'POST', {}, SearchRequest, SearchRequest$1, SearchResponse & SearchResponseNonNullableFields, SearchResponse$1 & SearchResponseNonNullableFields$1>;
|
|
1402
|
+
declare function federatedSearch(): __PublicMethodMetaInfo<'POST', {}, FederatedSearchRequest, FederatedSearchRequest$1, FederatedSearchResponse & FederatedSearchResponseNonNullableFields, FederatedSearchResponse$1 & FederatedSearchResponseNonNullableFields$1>;
|
|
1403
|
+
declare function suggest(): __PublicMethodMetaInfo<'POST', {}, SuggestRequest, SuggestRequest$1, SuggestResponse, SuggestResponse$1>;
|
|
1404
|
+
declare function federatedSuggest(): __PublicMethodMetaInfo<'POST', {}, FederatedSuggestRequest, FederatedSuggestRequest$1, FederatedSuggestResponse & FederatedSuggestResponseNonNullableFields, FederatedSuggestResponse$1 & FederatedSuggestResponseNonNullableFields$1>;
|
|
1405
|
+
declare function related(): __PublicMethodMetaInfo<'POST', {}, RelatedRequest, RelatedRequest$1, RelatedResponse, RelatedResponse$1>;
|
|
1406
|
+
declare function autocomplete(): __PublicMethodMetaInfo<'POST', {}, AutocompleteRequest, AutocompleteRequest$1, AutocompleteResponse & AutocompleteResponseNonNullableFields, AutocompleteResponse$1 & AutocompleteResponseNonNullableFields$1>;
|
|
1407
|
+
declare function federatedAutocomplete(): __PublicMethodMetaInfo<'POST', {}, FederatedAutocompleteRequest, FederatedAutocompleteRequest$1, FederatedAutocompleteResponse & FederatedAutocompleteResponseNonNullableFields, FederatedAutocompleteResponse$1 & FederatedAutocompleteResponseNonNullableFields$1>;
|
|
1408
|
+
declare function trending(): __PublicMethodMetaInfo<'POST', {}, TrendingRequest, TrendingRequest$1, TrendingResponse & TrendingResponseNonNullableFields, TrendingResponse$1 & TrendingResponseNonNullableFields$1>;
|
|
1018
1409
|
|
|
1019
1410
|
type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
|
|
1411
|
+
declare const meta_autocomplete: typeof autocomplete;
|
|
1412
|
+
declare const meta_federatedAutocomplete: typeof federatedAutocomplete;
|
|
1413
|
+
declare const meta_federatedSearch: typeof federatedSearch;
|
|
1414
|
+
declare const meta_federatedSuggest: typeof federatedSuggest;
|
|
1415
|
+
declare const meta_related: typeof related;
|
|
1020
1416
|
declare const meta_search: typeof search;
|
|
1417
|
+
declare const meta_suggest: typeof suggest;
|
|
1418
|
+
declare const meta_trending: typeof trending;
|
|
1021
1419
|
declare namespace meta {
|
|
1022
|
-
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_search as search };
|
|
1420
|
+
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_autocomplete as autocomplete, meta_federatedAutocomplete as federatedAutocomplete, meta_federatedSearch as federatedSearch, meta_federatedSuggest as federatedSuggest, meta_related as related, meta_search as search, meta_suggest as suggest, meta_trending as trending };
|
|
1023
1421
|
}
|
|
1024
1422
|
|
|
1025
1423
|
export { meta as siteSearch, meta$1 as wixSiteSearch };
|