@wix/search 1.0.26 → 1.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/search",
-  "version": "1.0.26",
+  "version": "1.0.28",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,8 +18,8 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/search_site-search": "1.0.18",
-    "@wix/search_wix-site-search": "1.0.5"
+    "@wix/search_site-search": "1.0.19",
+    "@wix/search_wix-site-search": "1.0.7"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -43,5 +43,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "c99c829af6b73405b814dbc570e8fc40a712c72b25967fc25454c1fa"
+  "falconPackageHash": "f76a2bdf45e6153d596019d0f49d1bd1b2f645f6006a9a787aa74524"
 }

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

@@ -1,316 +1,8 @@
-interface SiteDocument {
-    /**
-     * Results ID.
-     * @readonly
-     */
-    _id?: string;
-    /** The docuement payload. */
-    data?: Record<string, any> | null;
-}
-interface Search extends SearchPagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
-     */
-    sort?: Sorting[];
-    /**
-     * A search method for grouping data into various categories (facets) and providing summaries for each category.
-     * For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories such as price ranges, brand names, and ratings.
-     */
-    aggregations?: Aggregation$1[];
-    /** Free text to match in searchable fields. */
-    search?: SearchDetails;
-}
-/** @oneof */
-interface SearchPagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-}
-interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-interface Aggregation$1 extends AggregationKindOneOf {
-    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
-    value?: ValueAggregation;
-    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
-    scalar?: ScalarAggregation;
-    /**
-     * A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
-     * For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`.
-     */
-    nested?: NestedAggregation;
-    /** Aggregation name displayed in the return. */
-    name?: string | null;
-    /** Type of aggregation to perform. */
-    type?: AggregationType;
-    /** Field to aggregate by. */
-    fieldPath?: string;
-}
-/** @oneof */
-interface AggregationKindOneOf {
-    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
-    value?: ValueAggregation;
-    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
-    scalar?: ScalarAggregation;
-    /**
-     * A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
-     * For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`.
-     */
-    nested?: NestedAggregation;
-}
-declare enum ScalarType {
-    UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
-    /** Minimum value */
-    MIN = "MIN",
-    /** Maximum value */
-    MAX = "MAX",
-    /** Sum of values */
-    SUM = "SUM"
-}
-declare enum NestedAggregationType {
-    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value */
-    VALUE = "VALUE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg */
-    SCALAR = "SCALAR"
-}
-interface ValueAggregation {
-    /**
-     * Number of aggregation results to return.
-     * Min: `1`
-     * Max: `250`
-     * Default: `10`
-     */
-    limit?: number | null;
-}
-interface ScalarAggregation {
-    /** Operation type for the scalar aggregation. */
-    type?: ScalarType;
-}
-interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
-    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
-    value?: ValueAggregation;
-    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
-    scalar?: ScalarAggregation;
-    /** Aggregation name displayed in the return. */
-    name?: string | null;
-    /** Type of aggregation to perform. */
-    type?: NestedAggregationType;
-    /** Field to aggregate by. */
-    fieldPath?: string;
-}
-/** @oneof */
-interface NestedAggregationItemKindOneOf {
-    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
-    value?: ValueAggregation;
-    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
-    scalar?: ScalarAggregation;
-}
-declare enum AggregationType {
-    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value */
-    VALUE = "VALUE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg */
-    SCALAR = "SCALAR",
-    /** Multi-level aggregation, where each next aggregation is nested within previous one */
-    NESTED = "NESTED"
-}
-/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
-interface NestedAggregation {
-    /** Flattened list of aggregations, where each aggregation is nested within previous one. */
-    nestedAggregations?: NestedAggregationItem[];
-}
-interface SearchDetails {
-    /** Search term or expression. */
-    expression?: string | null;
-    /**
-     * Fields to search in.
-     * If the array is empty, all fields are searched.
-     */
-    fields?: string[];
-    /**
-     * Whether to allow the search function to automatically correct typos or minor mistakes in the search expression.
-     * The search function uses an algorithm to find results that are close to what the site visitor typed.
-     */
-    fuzzy?: boolean;
-}
-interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-declare enum DocumentType {
-    UNSPECIFIED = "UNSPECIFIED",
-    BLOG_POSTS = "BLOG_POSTS",
-    BOOKING_SERVICES = "BOOKING_SERVICES",
-    EVENTS = "EVENTS",
-    FORUM_CONTENT = "FORUM_CONTENT",
-    ONLINE_PROGRAMS = "ONLINE_PROGRAMS",
-    PROGALLERY_ITEM = "PROGALLERY_ITEM",
-    STORES_PRODUCTS = "STORES_PRODUCTS"
-}
-interface SearchResponse$1 extends SearchResponsePagingOneOf {
-    /** Paging metadata for the next page of results. */
-    pagingOffsetMetadata?: PagingMetadata;
-    /** Documents matching the search query. */
-    siteDocumentItems?: SiteDocument[];
-    /** Aggregated data. */
-    aggregationData?: AggregationData;
-}
-/** @oneof */
-interface SearchResponsePagingOneOf {
-    /** Paging metadata for the next page of results. */
-    pagingOffsetMetadata?: PagingMetadata;
-}
-interface AggregationData {
-    /** List of the aggregated data results. */
-    results?: AggregationResults[];
-}
-interface ValueAggregationResult {
-    /** Value of the field */
-    value?: string;
-    count?: number;
-}
-interface ValueResults {
-    /** List of value aggregations */
-    results?: ValueAggregationResult[];
-}
-interface AggregationResultsScalarResult {
-    /** Type of scalar aggregation */
-    type?: ScalarType;
-    /** Value of the scalar aggregation */
-    value?: number;
-}
-interface ValueResult {
-    /** Value of the field */
-    value?: string;
-    /** Count of entities with this value */
-    count?: number | null;
-}
-interface ScalarResult {
-    /** Scalar aggregation results. */
-    value?: number;
-}
-interface NestedResultValue extends NestedResultValueResultOneOf {
-    /** Value aggregation results. */
-    value?: ValueResult;
-    /** Scalar aggregation results. */
-    scalar?: ScalarResult;
-}
-/** @oneof */
-interface NestedResultValueResultOneOf {
-    /** Value aggregation results. */
-    value?: ValueResult;
-    /** Scalar aggregation results. */
-    scalar?: ScalarResult;
-}
-interface Results {
-    /** List of nested aggregation results. */
-    results?: Record<string, NestedResultValue>;
-}
-/**
- * Results of `NESTED` aggregation type in a flattened form
- * aggregations in resulting array are keyed by requested aggregation `name`.
- */
-interface NestedResults {
-    /** List of nested aggregation results. */
-    results?: Results[];
-}
-interface AggregationResults extends AggregationResultsResultOneOf {
-    /** Value aggregation results. */
-    values?: ValueResults;
-    /** Scalar aggregation results. */
-    scalar?: AggregationResultsScalarResult;
-    /** Nested aggregation results. */
-    nested?: NestedResults;
-    /** Aggregation name defined in the request. */
-    name?: string;
-    /** Type of aggregation that was performed. */
-    type?: AggregationType;
-    /** Field the data was aggregated by. */
-    fieldPath?: string;
-}
-/** @oneof */
-interface AggregationResultsResultOneOf {
-    /** Value aggregation results. */
-    values?: ValueResults;
-    /** Scalar aggregation results. */
-    scalar?: AggregationResultsScalarResult;
-    /** Nested aggregation results. */
-    nested?: NestedResults;
-}
-interface PagingMetadata {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-}
-interface SearchResponseNonNullableFields$1 {
-    siteDocumentItems: {
-        _id: string;
-    }[];
-    aggregationData?: {
-        results: {
-            values?: {
-                results: {
-                    value: string;
-                    count: number;
-                }[];
-            };
-            scalar?: {
-                type: ScalarType;
-                value: number;
-            };
-            nested?: {
-                results: {
-                    results?: {
-                        value?: {
-                            value: string;
-                        };
-                        scalar?: {
-                            value: number;
-                        };
-                    };
-                }[];
-            };
-            name: string;
-            type: AggregationType;
-            fieldPath: string;
-        }[];
-    };
-}
-interface SearchOptions$1 {
-    /** Search query and aggregation information. */
-    search: Search;
-}
-
 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: (url: string | URL, init?: RequestInit) => Promise<Response>;
+    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> = {
@@ -340,438 +32,24 @@ declare global {
 	}
 }
 
-declare function search$3(httpClient: HttpClient): (documentType: DocumentType, language: string | null, options: SearchOptions$1) => Promise<SearchResponse$1 & SearchResponseNonNullableFields$1>;
+declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
-declare const search$2: BuildRESTFunction<typeof search$3>;
+declare const search$1: ReturnType<typeof createRESTModule$1<typeof publicSearch>>;
 
 declare namespace context$1 {
-  export { search$2 as search };
-}
-
-interface OrderingClauses {
-    ordering?: OrderingClause[];
-}
-interface OrderingClause {
-    fieldName?: string | null;
-    direction?: Direction;
-}
-declare enum Direction {
-    UninitializedDirection = "UninitializedDirection",
-    ASC = "ASC",
-    DESC = "DESC"
-}
-interface SearchPaging {
-    /**
-     * Number of items to skip in the result set.
-     * @deprecated
-     */
-    skip?: number;
-    /** Number of items to fetch (effectively page size). */
-    limit?: number;
-    /** Number of items to skip in the result set. */
-    offset?: number;
-}
-interface FacetClauses {
-    /** Each entry represents a single facet with parameters. */
-    clauses?: FacetClause[];
-}
-interface FacetClause extends FacetClauseClauseOneOf {
-    term?: TermFacet;
-    aggregation?: AggregationFacet;
-    hierarchical?: HierarchicalFacet;
-}
-/** @oneof */
-interface FacetClauseClauseOneOf {
-    term?: TermFacet;
-    aggregation?: AggregationFacet;
-    hierarchical?: HierarchicalFacet;
-}
-declare enum Aggregation {
-    MIN = "MIN",
-    MAX = "MAX",
-    SUM = "SUM"
-}
-interface HierarchicalFacet extends HierarchicalFacetClauseOneOf {
-    term?: TermFacet;
-    aggregation?: AggregationFacet;
-    nestedAggregation?: HierarchicalFacet;
-}
-/** @oneof */
-interface HierarchicalFacetClauseOneOf {
-    term?: TermFacet;
-    aggregation?: AggregationFacet;
-}
-interface TermFacet {
-    /** The name of the faceted attribute. */
-    name?: string;
-    /** Limit the number of facet values returned. Default is 10. */
-    limit?: number | null;
-}
-interface AggregationFacet {
-    /** The name of the faceted attribute. */
-    name?: string;
-    /** Aggregation type. */
-    aggregation?: Aggregation;
-}
-interface SearchProperty {
-    name?: string;
-    value?: any;
-}
-interface SearchResponse {
-    /** Documents matching filter and query. */
-    documents?: Record<string, any>[] | null;
-    nextPage?: NextPageResponse;
-    /**
-     * Facets provide "counts in categories" view. For example searching for "Nike" would return
-     * (Shoes, 5), (Socks, 2) indicating numbers for matching by each faceted field.
-     */
-    facets?: FacetsResponse[];
-}
-interface NextPageResponse {
-    /** Total number of items across all pages */
-    total?: number;
-    /** The number of items to skip */
-    skip?: number;
-    /** The number of items to retrieve in one page */
-    limit?: number;
-}
-interface FacetsResponse extends FacetsResponseResponseOneOf {
-    terms?: TermAggregationResponse;
-    minAggregation?: MinAggregationResponse;
-    maxAggregation?: MaxAggregationResponse;
-    minMaxAggregation?: MinMaxAggregationResponse;
-    hierarchicalAggregation?: HierarchicalAggregationResponse;
-    sumAggregation?: SumAggregationResponse;
-}
-/** @oneof */
-interface FacetsResponseResponseOneOf {
-    terms?: TermAggregationResponse;
-    minAggregation?: MinAggregationResponse;
-    maxAggregation?: MaxAggregationResponse;
-    minMaxAggregation?: MinMaxAggregationResponse;
-    hierarchicalAggregation?: HierarchicalAggregationResponse;
-    sumAggregation?: SumAggregationResponse;
-}
-interface FacetCountResponse {
-    /** Facet field value (for example "Shoes", "Socks") */
-    facetValue?: string;
-    /** Document count within the group */
-    count?: number;
-}
-interface Value {
-    value?: string;
-    facets?: FacetsResponse;
-    count?: number;
-}
-interface TermAggregationResponse {
-    /** Facet field (for example productCategory) */
-    facet?: string;
-    /** Facet values and document counts */
-    facets?: FacetCountResponse[];
-}
-interface MinAggregationResponse {
-    /** Facet field (for example productPrice) */
-    facet?: string;
-    /** The minimum value across all documents */
-    minValue?: number | null;
-}
-interface MaxAggregationResponse {
-    /** Facet field (for example productPrice) */
-    facet?: string;
-    /** The maximum value across all documents */
-    maxValue?: number | null;
-}
-interface MinMaxAggregationResponse {
-    /** Facet field (for example productPrice) */
-    facet?: string;
-    /** The minimum value across all documents */
-    minValue?: number | null;
-    /** The maximum value across all documents */
-    maxValue?: number | null;
-}
-interface HierarchicalAggregationResponse {
-    facet?: string;
-    values?: Value[];
-}
-interface SumAggregationResponse {
-    /** Facet field (for example productPrice) */
-    facet?: string;
-    /** The sum value across all documents */
-    value?: number | null;
-}
-interface FederatedSearchResponse {
-    /** Search results from multiple indexes. */
-    results?: FederatedSearchDocuments[];
-}
-interface FederatedSearchDocuments {
-    /** Document type of documents */
-    documentType?: string | null;
-    /** Documents of document type */
-    documents?: Record<string, any>[] | null;
-    /** Total count of matching documents for document type */
-    total?: number;
-}
-interface SuggestResponse {
-    /** Suggested documents. */
-    documents?: Record<string, any>[] | null;
-}
-interface FederatedSuggestResponse {
-    /** Suggest results from multiple indexes. */
-    results?: FederatedSuggestDocuments[];
-}
-interface FederatedSuggestDocuments {
-    /** Document type of documents */
-    documentType?: string | null;
-    /** Documents of document type */
-    documents?: Record<string, any>[] | null;
-}
-interface RelatedResponse {
-    /** Documents matching filter and query. */
-    documents?: Record<string, any>[] | null;
-}
-interface AutocompleteResponse {
-    /** Suggested phrases. */
-    values?: AutocompleteResponseValue[];
-}
-interface AutocompleteResponseValue {
-    /** Suggested phrase. */
-    query?: string;
-}
-interface FederatedAutocompleteResponse {
-    /** Suggested phrases from multiple indexes */
-    results?: FederatedAutocompleteResults[];
-}
-interface FederatedAutocompleteResults {
-    /** Document type of queries */
-    documentType?: string | null;
-    /** Suggested phrases */
-    values?: AutocompleteResponseValue[];
-}
-interface TrendingResponse {
-    results?: TrendingItems[];
-}
-interface TrendingItems {
-    documentType?: string;
-    documents?: Record<string, any>[] | null;
-}
-interface SearchResponseNonNullableFields {
-    nextPage?: {
-        total: number;
-        skip: number;
-        limit: number;
-    };
-    facets: {
-        terms?: {
-            facet: string;
-            facets: {
-                facetValue: string;
-                count: number;
-            }[];
-        };
-        minAggregation?: {
-            facet: string;
-        };
-        maxAggregation?: {
-            facet: string;
-        };
-        minMaxAggregation?: {
-            facet: string;
-        };
-        hierarchicalAggregation?: {
-            facet: string;
-            values: {
-                value: string;
-                count: number;
-            }[];
-        };
-        sumAggregation?: {
-            facet: string;
-        };
-    }[];
-}
-interface FederatedSearchResponseNonNullableFields {
-    results: {
-        total: number;
-    }[];
-}
-interface FederatedSuggestResponseNonNullableFields {
-    results: FederatedSuggestDocuments[];
-}
-interface AutocompleteResponseNonNullableFields {
-    values: {
-        query: string;
-    }[];
-}
-interface FederatedAutocompleteResponseNonNullableFields {
-    results: {
-        values: {
-            query: string;
-        }[];
-    }[];
-}
-interface TrendingResponseNonNullableFields {
-    results: {
-        documentType: string;
-    }[];
-}
-interface SearchOptions {
-    /** Text to search for. All searchable fields will be searched. */
-    query?: string | null;
-    /** Document type of documents to search for. All document types are searched if not provided. */
-    documentType?: string | null;
-    /** Fields to order by. */
-    ordering?: OrderingClauses;
-    /** Paging parameters. */
-    paging?: SearchPaging;
-    /** Language to search in. */
-    language?: string | null;
-    /** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
-    filter?: Record<string, any> | null;
-    /** The facets to retrieve. */
-    facets?: FacetClauses;
-    /** Enable fuzzy search (eg. query 'kalvin clein' will match document with 'calvin klein' in title). */
-    fuzzy?: boolean | null;
-    /** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
-    highlight?: boolean | null;
-    /** Searchable fields to search in. If not provided, search is executed on all searchable fields in schema */
-    searchFields?: string[];
-    /** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
-    fields?: string[];
-    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
-    properties?: SearchProperty[];
-    /** Include seo hidden documents. Defaults to false if not provided. */
-    includeSeoHidden?: boolean | null;
-}
-interface FederatedSearchOptions {
-    /** Query phrase to use. */
-    query?: string | null;
-    /** Language to search in. */
-    language?: string | null;
-    /** Limit of documents to return per document type. */
-    limit?: number | null;
-    /** Enable fuzzy search (for example query 'kalvin clein' will match document with 'calvin klein' in title). */
-    fuzzy?: boolean | null;
-    /** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
-    highlight?: boolean | null;
-    /** Searchable fields to search in. If not provided, search is executed on all searchable fields in schemas */
-    searchFields?: string[];
-    /** Document types to search in. If not provided, search is executed on all document types enabled for the site */
-    documentTypes?: string[];
-    /** Include seo hidden documents. Defaults to false if not provided. */
-    includeSeoHidden?: boolean | null;
-}
-interface SuggestOptions {
-    /** Text to search for. Fields configured in suggester configuration will be searched. */
-    query?: string | null;
-    /** Document type of documents to search for. All document types are searched if not provided. */
-    documentType?: string | null;
-    /** Fields to order by. */
-    ordering?: OrderingClauses;
-    /** Number of suggested document to return. */
-    limit?: number;
-    /** Language to search in. */
-    language?: string | null;
-    /** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
-    filter?: Record<string, any> | null;
-    /** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schema */
-    searchFields?: string[];
-    /** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
-    fields?: string[];
-    /** Include seo hidden documents. Defaults to false if not provided. */
-    includeSeoHidden?: boolean | null;
-    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
-    properties?: SearchProperty[];
-}
-interface FederatedSuggestOptions {
-    /** Text to search for. Fields configured in suggester configuration will be searched. */
-    query?: string | null;
-    /** Language to search in. */
-    language?: string | null;
-    /** Number of suggested document to return per document type. */
-    limit?: number;
-    /** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schemas */
-    searchFields?: string[];
-    /** Document types to search in. If not provided, search is executed on all document types enabled for the site */
-    documentTypes?: string[];
-    /** Include seo hidden documents. Defaults to false if not provided. */
-    includeSeoHidden?: boolean | null;
-}
-interface RelatedOptions {
-    /** ID of the document to fetch related documents for. */
-    documentId?: string | null;
-    /** Document type of the document. */
-    documentType?: string | null;
-    /** Fields to order by. */
-    ordering?: OrderingClauses;
-    /** Language to search in. */
-    language?: string | null;
-    /** Filter in platformized query language (for example {'field': {'$eq': 'value'}}). */
-    filter?: Record<string, any> | null;
-    /** Searchable fields to compare documents by. If not provided, all searchable fields in schema are used */
-    searchFields?: string[];
-    /** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
-    fields?: string[];
-    /** Number of related documents to return */
-    limit?: number;
-    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
-    properties?: SearchProperty[];
-    /** Include seo hidden documents. Defaults to false if not provided. */
-    includeSeoHidden?: boolean | null;
-}
-interface AutocompleteOptions {
-    /** Query phrase to fetch completions for. */
-    query?: string | null;
-    /** Document type to use to search for phrases. */
-    documentType?: string | null;
-    /** Limit of phrases to fetch. */
-    limit?: number;
-    /** Language to search in. */
-    language?: string | null;
-    /** Filter in platfromized query language (for example {'field': {'$eq': 'value'}}) */
-    filter?: Record<string, any> | null;
-    /** Searchable fields to use for query completion. If not provided, all searchable fields in schema are used */
-    searchFields?: string[];
-    /** Include seo hidden documents. Defaults to false if not provided. */
-    includeSeoHidden?: boolean | null;
-}
-interface FederatedAutocompleteOptions {
-    /** Query phrase to fetch completions for. */
-    query?: string | null;
-    /** Language to search in. */
-    language?: string | null;
-    /** Number of queries to return per document type. */
-    limit?: number;
-    /** Searchable fields to search in. If not provided, search is executed on all autocompletable fields in schemas */
-    searchFields?: string[];
-    /** Document types to autocomplete in. If not provided, autocomplete is executed on all document types enabled for the site */
-    documentTypes?: string[];
-    /** Include seo hidden documents. Defaults to false if not provided. */
-    includeSeoHidden?: boolean | null;
-}
-interface TrendingOptions {
-    documentTypes?: string[];
-    language?: string | null;
-    /** Include seo hidden documents. Defaults to false if not provided. */
-    includeSeoHidden?: boolean | null;
+  export { search$1 as search };
 }
 
-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 & FederatedSuggestResponseNonNullableFields>;
-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 createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
-declare const search: BuildRESTFunction<typeof search$1>;
-declare const federatedSearch: BuildRESTFunction<typeof federatedSearch$1>;
-declare const suggest: BuildRESTFunction<typeof suggest$1>;
-declare const federatedSuggest: BuildRESTFunction<typeof federatedSuggest$1>;
-declare const related: BuildRESTFunction<typeof related$1>;
-declare const autocomplete: BuildRESTFunction<typeof autocomplete$1>;
-declare const federatedAutocomplete: BuildRESTFunction<typeof federatedAutocomplete$1>;
-declare const trending: BuildRESTFunction<typeof trending$1>;
+declare const search: ReturnType<typeof createRESTModule<typeof publicSearch>>;
+declare const federatedSearch: ReturnType<typeof createRESTModule<typeof publicFederatedSearch>>;
+declare const suggest: ReturnType<typeof createRESTModule<typeof publicSuggest>>;
+declare const federatedSuggest: ReturnType<typeof createRESTModule<typeof publicFederatedSuggest>>;
+declare const related: ReturnType<typeof createRESTModule<typeof publicRelated>>;
+declare const autocomplete: ReturnType<typeof createRESTModule<typeof publicAutocomplete>>;
+declare const federatedAutocomplete: ReturnType<typeof createRESTModule<typeof publicFederatedAutocomplete>>;
+declare const trending: ReturnType<typeof createRESTModule<typeof publicTrending>>;
 
 declare const context_autocomplete: typeof autocomplete;
 declare const context_federatedAutocomplete: typeof federatedAutocomplete;

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

@@ -311,13 +311,14 @@ interface SearchResponseNonNullableFields$1 {
     };
 }
 interface SearchOptions$1 {
-    /** Search query and aggregation information. */
-    search: Search;
+    /** Language to search in. */
+    language?: string | null;
 }
 
 interface HttpClient {
     request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+    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> = {
@@ -349,7 +350,7 @@ declare global {
 declare const __metadata$1: {
     PACKAGE_NAME: string;
 };
-declare function search$1(httpClient: HttpClient): (documentType: DocumentType, language: string | null, options: SearchOptions$1) => Promise<SearchResponse$1 & SearchResponseNonNullableFields$1>;
+declare function search$1(httpClient: HttpClient): (search: Search, documentType: DocumentType, options?: SearchOptions$1) => Promise<SearchResponse$1 & SearchResponseNonNullableFields$1>;
 
 type index_d$1_AggregationData = AggregationData;
 type index_d$1_AggregationKindOneOf = AggregationKindOneOf;