@wix/search 1.0.40 → 1.0.42

package/build/cjs/context.js

@@ -26,3 +26,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.siteSearch = exports.wixSiteSearch = void 0;
 exports.wixSiteSearch = __importStar(require("@wix/search_wix-site-search/context"));
 exports.siteSearch = __importStar(require("@wix/search_site-search/context"));
+//# sourceMappingURL=context.js.map

package/build/cjs/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../context.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qFAAqE;AACrE,8EAA8D"}

package/build/cjs/index.js

@@ -28,3 +28,4 @@ const wixSiteSearch = __importStar(require("@wix/search_wix-site-search"));
 exports.wixSiteSearch = wixSiteSearch;
 const siteSearch = __importStar(require("@wix/search_site-search"));
 exports.siteSearch = siteSearch;
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2EAA6D;AAGpD,sCAAa;AAFtB,oEAAsD;AAE9B,gCAAU"}

package/build/cjs/meta.js

@@ -26,3 +26,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.siteSearch = exports.wixSiteSearch = void 0;
 exports.wixSiteSearch = __importStar(require("@wix/search_wix-site-search/meta"));
 exports.siteSearch = __importStar(require("@wix/search_site-search/meta"));
+//# sourceMappingURL=meta.js.map

package/build/cjs/meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kFAAkE;AAClE,2EAA2D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/search",
-  "version": "1.0.40",
+  "version": "1.0.42",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,8 +18,8 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/search_site-search": "1.0.26",
-    "@wix/search_wix-site-search": "1.0.18"
+    "@wix/search_site-search": "1.0.27",
+    "@wix/search_wix-site-search": "1.0.19"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -44,5 +44,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "b910e408d72bf4a33be5a3673d19831f585b8b50b7e607b42bdc2847"
+  "falconPackageHash": "769bf9ed44899d3b1485a51273db36ae5d3a158bf620df3aad9e0d33"
 }

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

@@ -1,8 +1,47 @@
+type HostModule<T, H extends Host> = {
+    __type: 'host';
+    create(host: H): T;
+};
+type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
+type Host<Environment = unknown> = {
+    channel: {
+        observeState(callback: (props: unknown, environment: Environment) => unknown): {
+            disconnect: () => void;
+        } | Promise<{
+            disconnect: () => void;
+        }>;
+    };
+    environment?: Environment;
+    /**
+     * Optional bast url to use for API requests, for example `www.wixapis.com`
+     */
+    apiBaseUrl?: string;
+    /**
+     * Possible data to be provided by every host, for cross cutting concerns
+     * like internationalization, billing, etc.
+     */
+    essentials?: {
+        /**
+         * The language of the currently viewed session
+         */
+        language?: string;
+        /**
+         * The locale of the currently viewed session
+         */
+        locale?: string;
+        /**
+         * Any headers that should be passed through to the API requests
+         */
+        passThroughHeaders?: Record<string, string>;
+    };
+};
+
 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>;
+    getActiveToken?: () => string | undefined;
 }
 type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
 type HttpResponse<T = any> = {
@@ -24,6 +63,65 @@ type APIMetadata = {
     packageName?: string;
 };
 type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+type ServicePluginMethodInput = {
+    request: any;
+    metadata: any;
+};
+type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata = {
+    name: string;
+    primaryHttpMappingPath: string;
+    transformations: {
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
+        toREST: (...args: unknown[]) => unknown;
+    };
+};
+type ServicePluginDefinition<Contract extends ServicePluginContract> = {
+    __type: 'service-plugin-definition';
+    componentType: string;
+    methods: ServicePluginMethodMetadata[];
+    __contract: Contract;
+};
+declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
+type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
+declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
+
+type RequestContext = {
+    isSSR: boolean;
+    host: string;
+    protocol?: string;
+};
+type ResponseTransformer = (data: any, headers?: any) => any;
+/**
+ * Ambassador request options types are copied mostly from AxiosRequestConfig.
+ * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
+ * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
+ */
+type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
+type AmbassadorRequestOptions<T = any> = {
+    _?: T;
+    url?: string;
+    method?: Method;
+    params?: any;
+    data?: any;
+    transformResponse?: ResponseTransformer | ResponseTransformer[];
+};
+type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
+    __isAmbassador: boolean;
+};
+type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
+type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
 
 declare global {
 	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
@@ -32,6 +130,284 @@ declare global {
 	}
 }
 
+declare const emptyObjectSymbol: unique symbol;
+
+/**
+Represents a strictly empty plain object, the `{}` value.
+
+When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
+
+@example
+```
+import type {EmptyObject} from 'type-fest';
+
+// The following illustrates the problem with `{}`.
+const foo1: {} = {}; // Pass
+const foo2: {} = []; // Pass
+const foo3: {} = 42; // Pass
+const foo4: {} = {a: 1}; // Pass
+
+// With `EmptyObject` only the first case is valid.
+const bar1: EmptyObject = {}; // Pass
+const bar2: EmptyObject = 42; // Fail
+const bar3: EmptyObject = []; // Fail
+const bar4: EmptyObject = {a: 1}; // Fail
+```
+
+Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
+
+@category Object
+*/
+type EmptyObject = {[emptyObjectSymbol]?: never};
+
+/**
+Returns a boolean for whether the two given types are equal.
+
+@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
+
+Use-cases:
+- If you want to make a conditional branch based on the result of a comparison of two types.
+
+@example
+```
+import type {IsEqual} from 'type-fest';
+
+// This type returns a boolean for whether the given array includes the given item.
+// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
+type Includes<Value extends readonly any[], Item> =
+	Value extends readonly [Value[0], ...infer rest]
+		? IsEqual<Value[0], Item> extends true
+			? true
+			: Includes<rest, Item>
+		: false;
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsEqual<A, B> =
+	(<G>() => G extends A ? 1 : 2) extends
+	(<G>() => G extends B ? 1 : 2)
+		? true
+		: false;
+
+/**
+Filter out keys from an object.
+
+Returns `never` if `Exclude` is strictly equal to `Key`.
+Returns `never` if `Key` extends `Exclude`.
+Returns `Key` otherwise.
+
+@example
+```
+type Filtered = Filter<'foo', 'foo'>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', string>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', 'foo'>;
+//=> 'bar'
+```
+
+@see {Except}
+*/
+type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
+
+type ExceptOptions = {
+	/**
+	Disallow assigning non-specified properties.
+
+	Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
+
+	@default false
+	*/
+	requireExactProps?: boolean;
+};
+
+/**
+Create a type from an object type without certain keys.
+
+We recommend setting the `requireExactProps` option to `true`.
+
+This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
+
+This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
+
+@example
+```
+import type {Except} from 'type-fest';
+
+type Foo = {
+	a: number;
+	b: string;
+};
+
+type FooWithoutA = Except<Foo, 'a'>;
+//=> {b: string}
+
+const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
+//=> errors: 'a' does not exist in type '{ b: string; }'
+
+type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
+//=> {a: number} & Partial<Record<"b", never>>
+
+const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
+//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
+```
+
+@category Object
+*/
+type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
+	[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
+} & (Options['requireExactProps'] extends true
+	? Partial<Record<KeysType, never>>
+	: {});
+
+/**
+Extract the keys from a type where the value type of the key extends the given `Condition`.
+
+Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c?: string;
+	d: {};
+}
+
+type StringKeysOnly = ConditionalKeys<Example, string>;
+//=> 'a'
+```
+
+To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
+//=> 'a' | 'c'
+```
+
+@category Object
+*/
+type ConditionalKeys<Base, Condition> = NonNullable<
+// Wrap in `NonNullable` to strip away the `undefined` type from the produced union.
+{
+	// Map through all the keys of the given base type.
+	[Key in keyof Base]:
+	// Pick only keys with types extending the given `Condition` type.
+	Base[Key] extends Condition
+	// Retain this key since the condition passes.
+		? Key
+	// Discard this key since the condition fails.
+		: never;
+
+	// Convert the produced object into a union type of the keys which passed the conditional test.
+}[keyof Base]
+>;
+
+/**
+Exclude keys from a shape that matches the given `Condition`.
+
+This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
+
+@example
+```
+import type {Primitive, ConditionalExcept} from 'type-fest';
+
+class Awesome {
+	name: string;
+	successes: number;
+	failures: bigint;
+
+	run() {}
+}
+
+type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
+//=> {run: () => void}
+```
+
+@example
+```
+import type {ConditionalExcept} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c: () => void;
+	d: {};
+}
+
+type NonStringKeysOnly = ConditionalExcept<Example, string>;
+//=> {b: string | number; c: () => void; d: {}}
+```
+
+@category Object
+*/
+type ConditionalExcept<Base, Condition> = Except<
+Base,
+ConditionalKeys<Base, Condition>
+>;
+
+/**
+ * Descriptors are objects that describe the API of a module, and the module
+ * can either be a REST module or a host module.
+ * This type is recursive, so it can describe nested modules.
+ */
+type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
+    [key: string]: Descriptors | PublicMetadata | any;
+};
+/**
+ * This type takes in a descriptors object of a certain Host (including an `unknown` host)
+ * and returns an object with the same structure, but with all descriptors replaced with their API.
+ * Any non-descriptor properties are removed from the returned object, including descriptors that
+ * do not match the given host (as they will not work with the given host).
+ */
+type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
+    done: T;
+    recurse: T extends {
+        __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
+    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
+        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
+            -1,
+            0,
+            1,
+            2,
+            3,
+            4,
+            5
+        ][Depth]> : never;
+    }, EmptyObject>;
+}[Depth extends -1 ? 'done' : 'recurse'];
+type PublicMetadata = {
+    PACKAGE_NAME?: string;
+};
+
+declare global {
+    interface ContextualClient {
+    }
+}
+/**
+ * A type used to create concerete types from SDK descriptors in
+ * case a contextual client is available.
+ */
+type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
+    host: Host;
+} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
+
 interface SiteDocument$1 {
     /**
      * Result ID.
@@ -346,7 +722,7 @@ interface SearchSignature$1 {
     (search: Search, documentType: DocumentType, options?: SearchOptions$1 | undefined): Promise<SearchResponse$1 & SearchResponseNonNullableFields$1>;
 }
 
-declare const search$2: BuildRESTFunction<typeof search$3> & typeof search$3;
+declare const search$2: MaybeContext<BuildRESTFunction<typeof search$3> & typeof search$3>;
 
 type context$1_AggregationData = AggregationData;
 type context$1_AggregationKindOneOf = AggregationKindOneOf;
@@ -655,7 +1031,7 @@ interface SearchRequest {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty[];
     /** Include seo hidden documents. Defaults to false if not provided. */
     includeSeoHidden?: boolean | null;
@@ -828,6 +1204,8 @@ interface FederatedSearchRequest {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty[];
 }
 interface FederatedSearchResponse {
     /** Search results from multiple indexes. */
@@ -860,7 +1238,7 @@ interface SuggestRequest {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty[];
 }
 interface SuggestResponse {
@@ -880,6 +1258,8 @@ interface FederatedSuggestRequest {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty[];
 }
 interface FederatedSuggestResponse {
     /** Suggest results from multiple indexes. */
@@ -1071,7 +1451,7 @@ interface SearchOptions {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty[];
     /** Include seo hidden documents. Defaults to false if not provided. */
     includeSeoHidden?: boolean | null;
@@ -1093,6 +1473,8 @@ interface FederatedSearchOptions {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty[];
 }
 interface SuggestOptions {
     /** Text to search for. Fields configured in suggester configuration will be searched. */
@@ -1113,7 +1495,7 @@ interface SuggestOptions {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty[];
 }
 interface FederatedSuggestOptions {
@@ -1129,6 +1511,8 @@ interface FederatedSuggestOptions {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty[];
 }
 interface RelatedOptions {
     /** ID of the document to fetch related documents for. */
@@ -1252,14 +1636,14 @@ interface TrendingSignature {
     (options?: TrendingOptions | undefined): Promise<TrendingResponse & TrendingResponseNonNullableFields>;
 }
 
-declare const search: BuildRESTFunction<typeof search$1> & typeof search$1;
-declare const federatedSearch: BuildRESTFunction<typeof federatedSearch$1> & typeof federatedSearch$1;
-declare const suggest: BuildRESTFunction<typeof suggest$1> & typeof suggest$1;
-declare const federatedSuggest: BuildRESTFunction<typeof federatedSuggest$1> & typeof federatedSuggest$1;
-declare const related: BuildRESTFunction<typeof related$1> & typeof related$1;
-declare const autocomplete: BuildRESTFunction<typeof autocomplete$1> & typeof autocomplete$1;
-declare const federatedAutocomplete: BuildRESTFunction<typeof federatedAutocomplete$1> & typeof federatedAutocomplete$1;
-declare const trending: BuildRESTFunction<typeof trending$1> & typeof trending$1;
+declare const search: MaybeContext<BuildRESTFunction<typeof search$1> & typeof search$1>;
+declare const federatedSearch: MaybeContext<BuildRESTFunction<typeof federatedSearch$1> & typeof federatedSearch$1>;
+declare const suggest: MaybeContext<BuildRESTFunction<typeof suggest$1> & typeof suggest$1>;
+declare const federatedSuggest: MaybeContext<BuildRESTFunction<typeof federatedSuggest$1> & typeof federatedSuggest$1>;
+declare const related: MaybeContext<BuildRESTFunction<typeof related$1> & typeof related$1>;
+declare const autocomplete: MaybeContext<BuildRESTFunction<typeof autocomplete$1> & typeof autocomplete$1>;
+declare const federatedAutocomplete: MaybeContext<BuildRESTFunction<typeof federatedAutocomplete$1> & typeof federatedAutocomplete$1>;
+declare const trending: MaybeContext<BuildRESTFunction<typeof trending$1> & typeof trending$1>;
 
 type context_Aggregation = Aggregation;
 declare const context_Aggregation: typeof Aggregation;

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

@@ -1,8 +1,47 @@
+type HostModule<T, H extends Host> = {
+    __type: 'host';
+    create(host: H): T;
+};
+type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
+type Host<Environment = unknown> = {
+    channel: {
+        observeState(callback: (props: unknown, environment: Environment) => unknown): {
+            disconnect: () => void;
+        } | Promise<{
+            disconnect: () => void;
+        }>;
+    };
+    environment?: Environment;
+    /**
+     * Optional bast url to use for API requests, for example `www.wixapis.com`
+     */
+    apiBaseUrl?: string;
+    /**
+     * Possible data to be provided by every host, for cross cutting concerns
+     * like internationalization, billing, etc.
+     */
+    essentials?: {
+        /**
+         * The language of the currently viewed session
+         */
+        language?: string;
+        /**
+         * The locale of the currently viewed session
+         */
+        locale?: string;
+        /**
+         * Any headers that should be passed through to the API requests
+         */
+        passThroughHeaders?: Record<string, string>;
+    };
+};
+
 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>;
+    getActiveToken?: () => string | undefined;
 }
 type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
 type HttpResponse<T = any> = {
@@ -24,6 +63,65 @@ type APIMetadata = {
     packageName?: string;
 };
 type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+type ServicePluginMethodInput = {
+    request: any;
+    metadata: any;
+};
+type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata = {
+    name: string;
+    primaryHttpMappingPath: string;
+    transformations: {
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
+        toREST: (...args: unknown[]) => unknown;
+    };
+};
+type ServicePluginDefinition<Contract extends ServicePluginContract> = {
+    __type: 'service-plugin-definition';
+    componentType: string;
+    methods: ServicePluginMethodMetadata[];
+    __contract: Contract;
+};
+declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
+type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
+declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
+
+type RequestContext = {
+    isSSR: boolean;
+    host: string;
+    protocol?: string;
+};
+type ResponseTransformer = (data: any, headers?: any) => any;
+/**
+ * Ambassador request options types are copied mostly from AxiosRequestConfig.
+ * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
+ * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
+ */
+type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
+type AmbassadorRequestOptions<T = any> = {
+    _?: T;
+    url?: string;
+    method?: Method;
+    params?: any;
+    data?: any;
+    transformResponse?: ResponseTransformer | ResponseTransformer[];
+};
+type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
+    __isAmbassador: boolean;
+};
+type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
+type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
 
 declare global {
 	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
@@ -32,6 +130,284 @@ declare global {
 	}
 }
 
+declare const emptyObjectSymbol: unique symbol;
+
+/**
+Represents a strictly empty plain object, the `{}` value.
+
+When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
+
+@example
+```
+import type {EmptyObject} from 'type-fest';
+
+// The following illustrates the problem with `{}`.
+const foo1: {} = {}; // Pass
+const foo2: {} = []; // Pass
+const foo3: {} = 42; // Pass
+const foo4: {} = {a: 1}; // Pass
+
+// With `EmptyObject` only the first case is valid.
+const bar1: EmptyObject = {}; // Pass
+const bar2: EmptyObject = 42; // Fail
+const bar3: EmptyObject = []; // Fail
+const bar4: EmptyObject = {a: 1}; // Fail
+```
+
+Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
+
+@category Object
+*/
+type EmptyObject = {[emptyObjectSymbol]?: never};
+
+/**
+Returns a boolean for whether the two given types are equal.
+
+@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
+
+Use-cases:
+- If you want to make a conditional branch based on the result of a comparison of two types.
+
+@example
+```
+import type {IsEqual} from 'type-fest';
+
+// This type returns a boolean for whether the given array includes the given item.
+// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
+type Includes<Value extends readonly any[], Item> =
+	Value extends readonly [Value[0], ...infer rest]
+		? IsEqual<Value[0], Item> extends true
+			? true
+			: Includes<rest, Item>
+		: false;
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsEqual<A, B> =
+	(<G>() => G extends A ? 1 : 2) extends
+	(<G>() => G extends B ? 1 : 2)
+		? true
+		: false;
+
+/**
+Filter out keys from an object.
+
+Returns `never` if `Exclude` is strictly equal to `Key`.
+Returns `never` if `Key` extends `Exclude`.
+Returns `Key` otherwise.
+
+@example
+```
+type Filtered = Filter<'foo', 'foo'>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', string>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', 'foo'>;
+//=> 'bar'
+```
+
+@see {Except}
+*/
+type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
+
+type ExceptOptions = {
+	/**
+	Disallow assigning non-specified properties.
+
+	Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
+
+	@default false
+	*/
+	requireExactProps?: boolean;
+};
+
+/**
+Create a type from an object type without certain keys.
+
+We recommend setting the `requireExactProps` option to `true`.
+
+This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
+
+This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
+
+@example
+```
+import type {Except} from 'type-fest';
+
+type Foo = {
+	a: number;
+	b: string;
+};
+
+type FooWithoutA = Except<Foo, 'a'>;
+//=> {b: string}
+
+const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
+//=> errors: 'a' does not exist in type '{ b: string; }'
+
+type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
+//=> {a: number} & Partial<Record<"b", never>>
+
+const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
+//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
+```
+
+@category Object
+*/
+type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
+	[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
+} & (Options['requireExactProps'] extends true
+	? Partial<Record<KeysType, never>>
+	: {});
+
+/**
+Extract the keys from a type where the value type of the key extends the given `Condition`.
+
+Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c?: string;
+	d: {};
+}
+
+type StringKeysOnly = ConditionalKeys<Example, string>;
+//=> 'a'
+```
+
+To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
+//=> 'a' | 'c'
+```
+
+@category Object
+*/
+type ConditionalKeys<Base, Condition> = NonNullable<
+// Wrap in `NonNullable` to strip away the `undefined` type from the produced union.
+{
+	// Map through all the keys of the given base type.
+	[Key in keyof Base]:
+	// Pick only keys with types extending the given `Condition` type.
+	Base[Key] extends Condition
+	// Retain this key since the condition passes.
+		? Key
+	// Discard this key since the condition fails.
+		: never;
+
+	// Convert the produced object into a union type of the keys which passed the conditional test.
+}[keyof Base]
+>;
+
+/**
+Exclude keys from a shape that matches the given `Condition`.
+
+This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
+
+@example
+```
+import type {Primitive, ConditionalExcept} from 'type-fest';
+
+class Awesome {
+	name: string;
+	successes: number;
+	failures: bigint;
+
+	run() {}
+}
+
+type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
+//=> {run: () => void}
+```
+
+@example
+```
+import type {ConditionalExcept} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c: () => void;
+	d: {};
+}
+
+type NonStringKeysOnly = ConditionalExcept<Example, string>;
+//=> {b: string | number; c: () => void; d: {}}
+```
+
+@category Object
+*/
+type ConditionalExcept<Base, Condition> = Except<
+Base,
+ConditionalKeys<Base, Condition>
+>;
+
+/**
+ * Descriptors are objects that describe the API of a module, and the module
+ * can either be a REST module or a host module.
+ * This type is recursive, so it can describe nested modules.
+ */
+type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
+    [key: string]: Descriptors | PublicMetadata | any;
+};
+/**
+ * This type takes in a descriptors object of a certain Host (including an `unknown` host)
+ * and returns an object with the same structure, but with all descriptors replaced with their API.
+ * Any non-descriptor properties are removed from the returned object, including descriptors that
+ * do not match the given host (as they will not work with the given host).
+ */
+type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
+    done: T;
+    recurse: T extends {
+        __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
+    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
+        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
+            -1,
+            0,
+            1,
+            2,
+            3,
+            4,
+            5
+        ][Depth]> : never;
+    }, EmptyObject>;
+}[Depth extends -1 ? 'done' : 'recurse'];
+type PublicMetadata = {
+    PACKAGE_NAME?: string;
+};
+
+declare global {
+    interface ContextualClient {
+    }
+}
+/**
+ * A type used to create concerete types from SDK descriptors in
+ * case a contextual client is available.
+ */
+type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
+    host: Host;
+} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
+
 interface SiteDocument$1 {
     /**
      * Result ID.
@@ -346,7 +722,7 @@ interface SearchSignature$1 {
     (search: Search, documentType: DocumentType, options?: SearchOptions$1 | undefined): Promise<SearchResponse$1 & SearchResponseNonNullableFields$1>;
 }
 
-declare const search$2: BuildRESTFunction<typeof search$3> & typeof search$3;
+declare const search$2: MaybeContext<BuildRESTFunction<typeof search$3> & typeof search$3>;
 
 type index_d$1_AggregationData = AggregationData;
 type index_d$1_AggregationKindOneOf = AggregationKindOneOf;
@@ -655,7 +1031,7 @@ interface SearchRequest {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty[];
     /** Include seo hidden documents. Defaults to false if not provided. */
     includeSeoHidden?: boolean | null;
@@ -828,6 +1204,8 @@ interface FederatedSearchRequest {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty[];
 }
 interface FederatedSearchResponse {
     /** Search results from multiple indexes. */
@@ -860,7 +1238,7 @@ interface SuggestRequest {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty[];
 }
 interface SuggestResponse {
@@ -880,6 +1258,8 @@ interface FederatedSuggestRequest {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty[];
 }
 interface FederatedSuggestResponse {
     /** Suggest results from multiple indexes. */
@@ -1071,7 +1451,7 @@ interface SearchOptions {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty[];
     /** Include seo hidden documents. Defaults to false if not provided. */
     includeSeoHidden?: boolean | null;
@@ -1093,6 +1473,8 @@ interface FederatedSearchOptions {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty[];
 }
 interface SuggestOptions {
     /** Text to search for. Fields configured in suggester configuration will be searched. */
@@ -1113,7 +1495,7 @@ interface SuggestOptions {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty[];
 }
 interface FederatedSuggestOptions {
@@ -1129,6 +1511,8 @@ interface FederatedSuggestOptions {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty[];
 }
 interface RelatedOptions {
     /** ID of the document to fetch related documents for. */
@@ -1252,14 +1636,14 @@ interface TrendingSignature {
     (options?: TrendingOptions | undefined): Promise<TrendingResponse & TrendingResponseNonNullableFields>;
 }
 
-declare const search: BuildRESTFunction<typeof search$1> & typeof search$1;
-declare const federatedSearch: BuildRESTFunction<typeof federatedSearch$1> & typeof federatedSearch$1;
-declare const suggest: BuildRESTFunction<typeof suggest$1> & typeof suggest$1;
-declare const federatedSuggest: BuildRESTFunction<typeof federatedSuggest$1> & typeof federatedSuggest$1;
-declare const related: BuildRESTFunction<typeof related$1> & typeof related$1;
-declare const autocomplete: BuildRESTFunction<typeof autocomplete$1> & typeof autocomplete$1;
-declare const federatedAutocomplete: BuildRESTFunction<typeof federatedAutocomplete$1> & typeof federatedAutocomplete$1;
-declare const trending: BuildRESTFunction<typeof trending$1> & typeof trending$1;
+declare const search: MaybeContext<BuildRESTFunction<typeof search$1> & typeof search$1>;
+declare const federatedSearch: MaybeContext<BuildRESTFunction<typeof federatedSearch$1> & typeof federatedSearch$1>;
+declare const suggest: MaybeContext<BuildRESTFunction<typeof suggest$1> & typeof suggest$1>;
+declare const federatedSuggest: MaybeContext<BuildRESTFunction<typeof federatedSuggest$1> & typeof federatedSuggest$1>;
+declare const related: MaybeContext<BuildRESTFunction<typeof related$1> & typeof related$1>;
+declare const autocomplete: MaybeContext<BuildRESTFunction<typeof autocomplete$1> & typeof autocomplete$1>;
+declare const federatedAutocomplete: MaybeContext<BuildRESTFunction<typeof federatedAutocomplete$1> & typeof federatedAutocomplete$1>;
+declare const trending: MaybeContext<BuildRESTFunction<typeof trending$1> & typeof trending$1>;
 
 type index_d_Aggregation = Aggregation;
 declare const index_d_Aggregation: typeof Aggregation;

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

@@ -629,7 +629,7 @@ interface SearchRequest$1 {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty$1[];
     /** Include seo hidden documents. Defaults to false if not provided. */
     includeSeoHidden?: boolean | null;
@@ -802,6 +802,8 @@ interface FederatedSearchRequest$1 {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty$1[];
 }
 interface FederatedSearchResponse$1 {
     /** Search results from multiple indexes. */
@@ -834,7 +836,7 @@ interface SuggestRequest$1 {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty$1[];
 }
 interface SuggestResponse$1 {
@@ -854,6 +856,8 @@ interface FederatedSuggestRequest$1 {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty$1[];
 }
 interface FederatedSuggestResponse$1 {
     /** Suggest results from multiple indexes. */
@@ -1046,7 +1050,7 @@ interface SearchRequest {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty[];
     /** Include seo hidden documents. Defaults to false if not provided. */
     includeSeoHidden?: boolean | null;
@@ -1219,6 +1223,8 @@ interface FederatedSearchRequest {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty[];
 }
 interface FederatedSearchResponse {
     /** Search results from multiple indexes. */
@@ -1251,7 +1257,7 @@ interface SuggestRequest {
     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`. */
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
     properties?: SearchProperty[];
 }
 interface SuggestResponse {
@@ -1271,6 +1277,8 @@ interface FederatedSuggestRequest {
     documentTypes?: 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`, `result-format`. */
+    properties?: SearchProperty[];
 }
 interface FederatedSuggestResponse {
     /** Suggest results from multiple indexes. */