@wix/search 1.0.36 → 1.0.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/search",
-  "version": "1.0.36",
+  "version": "1.0.37",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,8 +18,8 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/search_site-search": "1.0.23",
-    "@wix/search_wix-site-search": "1.0.14"
+    "@wix/search_site-search": "1.0.24",
+    "@wix/search_wix-site-search": "1.0.15"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -44,5 +44,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "b0479d3a057bc39aacafaae456145287a381bf362346fa0e2f2052f5"
+  "falconPackageHash": "6323dd4dd320358e403019c826eaeaf75534e19c74cbeda637857c36"
 }

package/type-bundles/context.bundle.d.ts

@@ -1,3 +1,37 @@
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 interface SiteDocument$1 {
     /**
      * Result ID.
@@ -298,42 +332,20 @@ interface SearchOptions$1 {
     language?: string | null;
 }
 
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
-}
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function search$3(httpClient: HttpClient): SearchSignature$1;
+interface SearchSignature$1 {
+    /**
+     * Retrieves a list of site documents that match the provided search query and optionally performs aggregations on the data queried.
+     *
+     * The Search API supports the document types listed in the [Introduction](https://dev.wix.com/docs/rest/business-management/search/wix-site-search/introduction), each with its own schema. These schemas define the fields available for filtering, sorting, and free-text searching.
+     *
+     * To learn more about working with the search query, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
+     * @param - Search query and aggregation information.
+     * @param - Document type to search in.
+     */
+    (search: Search, documentType: DocumentType, options?: SearchOptions$1 | undefined): Promise<SearchResponse$1 & SearchResponseNonNullableFields$1>;
 }
 
-declare function search$3(httpClient: HttpClient): (search: Search, documentType: DocumentType, options?: SearchOptions$1) => Promise<SearchResponse$1 & SearchResponseNonNullableFields$1>;
-
 declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
 type _publicSearchType$1 = typeof search$3;
@@ -1180,14 +1192,68 @@ interface TrendingOptions {
     includeSeoHidden?: boolean | null;
 }
 
-declare function search$1(httpClient: HttpClient): (options?: SearchOptions) => Promise<SearchResponse & SearchResponseNonNullableFields>;
-declare function federatedSearch$1(httpClient: HttpClient): (options?: FederatedSearchOptions) => Promise<FederatedSearchResponse & FederatedSearchResponseNonNullableFields>;
-declare function suggest$1(httpClient: HttpClient): (options?: SuggestOptions) => Promise<SuggestResponse>;
-declare function federatedSuggest$1(httpClient: HttpClient): (options?: FederatedSuggestOptions) => Promise<FederatedSuggestResponse>;
-declare function related$1(httpClient: HttpClient): (options?: RelatedOptions) => Promise<RelatedResponse>;
-declare function autocomplete$1(httpClient: HttpClient): (options?: AutocompleteOptions) => Promise<AutocompleteResponse & AutocompleteResponseNonNullableFields>;
-declare function federatedAutocomplete$1(httpClient: HttpClient): (options?: FederatedAutocompleteOptions) => Promise<FederatedAutocompleteResponse & FederatedAutocompleteResponseNonNullableFields>;
-declare function trending$1(httpClient: HttpClient): (options?: TrendingOptions) => Promise<TrendingResponse & TrendingResponseNonNullableFields>;
+declare function search$1(httpClient: HttpClient): SearchSignature;
+interface SearchSignature {
+    /**
+     * Executes a regular search query.
+     * If you are unsure, this is likely the search method you want to used.
+     */
+    (options?: SearchOptions | undefined): Promise<SearchResponse & SearchResponseNonNullableFields>;
+}
+declare function federatedSearch$1(httpClient: HttpClient): FederatedSearchSignature;
+interface FederatedSearchSignature {
+    /**
+     * Searches in multiple document types at once.
+     */
+    (options?: FederatedSearchOptions | undefined): Promise<FederatedSearchResponse & FederatedSearchResponseNonNullableFields>;
+}
+declare function suggest$1(httpClient: HttpClient): SuggestSignature;
+interface SuggestSignature {
+    /**
+     * Executes search query to fetch suggested items. Unlike search query suggest will match
+     * partial phrases (for example "blu" will match documents containing "blue", "blues" and "blunt").
+     * Phrase needs to be at least 3 symbols long. Suggestions can also perform optimisations in search
+     * results and generally do not guarantee the same level of quality as regular Search endpoint.
+     */
+    (options?: SuggestOptions | undefined): Promise<SuggestResponse>;
+}
+declare function federatedSuggest$1(httpClient: HttpClient): FederatedSuggestSignature;
+interface FederatedSuggestSignature {
+    /**
+     * Searches for suggestions in multiple document types at once.
+     */
+    (options?: FederatedSuggestOptions | undefined): Promise<FederatedSuggestResponse>;
+}
+declare function related$1(httpClient: HttpClient): RelatedSignature;
+interface RelatedSignature {
+    /**
+     * Fetches documents similar to one single document.
+     * This is typically used to implement "related to" scenarios (for example to fetch related store products when
+     * consumer is already viewing one).
+     */
+    (options?: RelatedOptions | undefined): Promise<RelatedResponse>;
+}
+declare function autocomplete$1(httpClient: HttpClient): AutocompleteSignature;
+interface AutocompleteSignature {
+    /**
+     * Provides phrase completion. For example "blu" could return "blue", "blues" and "blunt" as candidate phrases. This operation is resource heavy at index time and is reserved for special use cases.
+     */
+    (options?: AutocompleteOptions | undefined): Promise<AutocompleteResponse & AutocompleteResponseNonNullableFields>;
+}
+declare function federatedAutocomplete$1(httpClient: HttpClient): FederatedAutocompleteSignature;
+interface FederatedAutocompleteSignature {
+    /**
+     * Provides phrase completion from multiple document types at once
+     */
+    (options?: FederatedAutocompleteOptions | undefined): Promise<FederatedAutocompleteResponse & FederatedAutocompleteResponseNonNullableFields>;
+}
+declare function trending$1(httpClient: HttpClient): TrendingSignature;
+interface TrendingSignature {
+    /**
+     * Returns trending documents for given document types
+     */
+    (options?: TrendingOptions | undefined): Promise<TrendingResponse & TrendingResponseNonNullableFields>;
+}
 
 declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 

package/type-bundles/index.bundle.d.ts

@@ -1,3 +1,37 @@
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 interface SiteDocument$1 {
     /**
      * Result ID.
@@ -298,42 +332,20 @@ interface SearchOptions$1 {
     language?: string | null;
 }
 
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
-}
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function search$3(httpClient: HttpClient): SearchSignature$1;
+interface SearchSignature$1 {
+    /**
+     * Retrieves a list of site documents that match the provided search query and optionally performs aggregations on the data queried.
+     *
+     * The Search API supports the document types listed in the [Introduction](https://dev.wix.com/docs/rest/business-management/search/wix-site-search/introduction), each with its own schema. These schemas define the fields available for filtering, sorting, and free-text searching.
+     *
+     * To learn more about working with the search query, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
+     * @param - Search query and aggregation information.
+     * @param - Document type to search in.
+     */
+    (search: Search, documentType: DocumentType, options?: SearchOptions$1 | undefined): Promise<SearchResponse$1 & SearchResponseNonNullableFields$1>;
 }
 
-declare function search$3(httpClient: HttpClient): (search: Search, documentType: DocumentType, options?: SearchOptions$1) => Promise<SearchResponse$1 & SearchResponseNonNullableFields$1>;
-
 declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
 type _publicSearchType$1 = typeof search$3;
@@ -1180,14 +1192,68 @@ interface TrendingOptions {
     includeSeoHidden?: boolean | null;
 }
 
-declare function search$1(httpClient: HttpClient): (options?: SearchOptions) => Promise<SearchResponse & SearchResponseNonNullableFields>;
-declare function federatedSearch$1(httpClient: HttpClient): (options?: FederatedSearchOptions) => Promise<FederatedSearchResponse & FederatedSearchResponseNonNullableFields>;
-declare function suggest$1(httpClient: HttpClient): (options?: SuggestOptions) => Promise<SuggestResponse>;
-declare function federatedSuggest$1(httpClient: HttpClient): (options?: FederatedSuggestOptions) => Promise<FederatedSuggestResponse>;
-declare function related$1(httpClient: HttpClient): (options?: RelatedOptions) => Promise<RelatedResponse>;
-declare function autocomplete$1(httpClient: HttpClient): (options?: AutocompleteOptions) => Promise<AutocompleteResponse & AutocompleteResponseNonNullableFields>;
-declare function federatedAutocomplete$1(httpClient: HttpClient): (options?: FederatedAutocompleteOptions) => Promise<FederatedAutocompleteResponse & FederatedAutocompleteResponseNonNullableFields>;
-declare function trending$1(httpClient: HttpClient): (options?: TrendingOptions) => Promise<TrendingResponse & TrendingResponseNonNullableFields>;
+declare function search$1(httpClient: HttpClient): SearchSignature;
+interface SearchSignature {
+    /**
+     * Executes a regular search query.
+     * If you are unsure, this is likely the search method you want to used.
+     */
+    (options?: SearchOptions | undefined): Promise<SearchResponse & SearchResponseNonNullableFields>;
+}
+declare function federatedSearch$1(httpClient: HttpClient): FederatedSearchSignature;
+interface FederatedSearchSignature {
+    /**
+     * Searches in multiple document types at once.
+     */
+    (options?: FederatedSearchOptions | undefined): Promise<FederatedSearchResponse & FederatedSearchResponseNonNullableFields>;
+}
+declare function suggest$1(httpClient: HttpClient): SuggestSignature;
+interface SuggestSignature {
+    /**
+     * Executes search query to fetch suggested items. Unlike search query suggest will match
+     * partial phrases (for example "blu" will match documents containing "blue", "blues" and "blunt").
+     * Phrase needs to be at least 3 symbols long. Suggestions can also perform optimisations in search
+     * results and generally do not guarantee the same level of quality as regular Search endpoint.
+     */
+    (options?: SuggestOptions | undefined): Promise<SuggestResponse>;
+}
+declare function federatedSuggest$1(httpClient: HttpClient): FederatedSuggestSignature;
+interface FederatedSuggestSignature {
+    /**
+     * Searches for suggestions in multiple document types at once.
+     */
+    (options?: FederatedSuggestOptions | undefined): Promise<FederatedSuggestResponse>;
+}
+declare function related$1(httpClient: HttpClient): RelatedSignature;
+interface RelatedSignature {
+    /**
+     * Fetches documents similar to one single document.
+     * This is typically used to implement "related to" scenarios (for example to fetch related store products when
+     * consumer is already viewing one).
+     */
+    (options?: RelatedOptions | undefined): Promise<RelatedResponse>;
+}
+declare function autocomplete$1(httpClient: HttpClient): AutocompleteSignature;
+interface AutocompleteSignature {
+    /**
+     * Provides phrase completion. For example "blu" could return "blue", "blues" and "blunt" as candidate phrases. This operation is resource heavy at index time and is reserved for special use cases.
+     */
+    (options?: AutocompleteOptions | undefined): Promise<AutocompleteResponse & AutocompleteResponseNonNullableFields>;
+}
+declare function federatedAutocomplete$1(httpClient: HttpClient): FederatedAutocompleteSignature;
+interface FederatedAutocompleteSignature {
+    /**
+     * Provides phrase completion from multiple document types at once
+     */
+    (options?: FederatedAutocompleteOptions | undefined): Promise<FederatedAutocompleteResponse & FederatedAutocompleteResponseNonNullableFields>;
+}
+declare function trending$1(httpClient: HttpClient): TrendingSignature;
+interface TrendingSignature {
+    /**
+     * Returns trending documents for given document types
+     */
+    (options?: TrendingOptions | undefined): Promise<TrendingResponse & TrendingResponseNonNullableFields>;
+}
 
 declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;