@wix/search 1.0.43 → 1.0.45

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/search",
-  "version": "1.0.43",
+  "version": "1.0.45",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,8 +18,8 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/search_site-search": "1.0.28",
-    "@wix/search_wix-site-search": "1.0.20"
+    "@wix/search_site-search": "1.0.29",
+    "@wix/search_wix-site-search": "1.0.21"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -44,5 +44,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "bb418f4be5dfcd9cb89b029f462209b98cb9a5e8c303afb82a37750c"
+  "falconPackageHash": "3452857f955659e2c276b1c34137433c21c44b76bc842927dc46b990"
 }

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

@@ -12,6 +12,10 @@ type Host<Environment = unknown> = {
         }>;
     };
     environment?: Environment;
+    /**
+     * Optional name of the environment, use for logging
+     */
+    name?: string;
     /**
      * Optional bast url to use for API requests, for example `www.wixapis.com`
      */
@@ -271,6 +275,72 @@ type Except<ObjectType, KeysType extends keyof ObjectType, Options extends Excep
 	? Partial<Record<KeysType, never>>
 	: {});
 
+/**
+Returns a boolean for whether the given type is `never`.
+
+@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
+@link https://stackoverflow.com/a/53984913/10292952
+@link https://www.zhenghao.io/posts/ts-never
+
+Useful in type utilities, such as checking if something does not occur.
+
+@example
+```
+import type {IsNever, And} from 'type-fest';
+
+// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
+type AreStringsEqual<A extends string, B extends string> =
+	And<
+		IsNever<Exclude<A, B>> extends true ? true : false,
+		IsNever<Exclude<B, A>> extends true ? true : false
+	>;
+
+type EndIfEqual<I extends string, O extends string> =
+	AreStringsEqual<I, O> extends true
+		? never
+		: void;
+
+function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
+	if (input === output) {
+		process.exit(0);
+	}
+}
+
+endIfEqual('abc', 'abc');
+//=> never
+
+endIfEqual('abc', '123');
+//=> void
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsNever<T> = [T] extends [never] ? true : false;
+
+/**
+An if-else-like type that resolves depending on whether the given type is `never`.
+
+@see {@link IsNever}
+
+@example
+```
+import type {IfNever} from 'type-fest';
+
+type ShouldBeTrue = IfNever<never>;
+//=> true
+
+type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
+//=> 'bar'
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
+	IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
+);
+
 /**
 Extract the keys from a type where the value type of the key extends the given `Condition`.
 
@@ -303,21 +373,19 @@ type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
 
 @category Object
 */
-type ConditionalKeys<Base, Condition> = NonNullable<
-// Wrap in `NonNullable` to strip away the `undefined` type from the produced union.
+type ConditionalKeys<Base, Condition> =
 {
 	// Map through all the keys of the given base type.
-	[Key in keyof Base]:
+	[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
+	// Retain this key
+	// If the value for the key extends never, only include it if `Condition` also extends never
+		? IfNever<Base[Key], IfNever<Condition, Key, never>, 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]
->;
+}[keyof Base];
 
 /**
 Exclude keys from a shape that matches the given `Condition`.
@@ -800,7 +868,7 @@ interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOpera
     /** id to pass to processing notification */
     correlationId?: string | null;
     /** when event was created / issued */
-    issuedAt?: Date;
+    issuedAt?: Date | null;
 }
 /** @oneof */
 interface UpdateInternalDocumentsEventOperationOneOf {
@@ -1352,6 +1420,8 @@ interface TrendingRequest {
     language?: string | null;
     /** 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 TrendingResponse {
     results?: TrendingItems[];
@@ -1573,6 +1643,8 @@ interface TrendingOptions {
     language?: string | null;
     /** 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[];
 }
 
 declare function search$1(httpClient: HttpClient): SearchSignature;

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

@@ -12,6 +12,10 @@ type Host<Environment = unknown> = {
         }>;
     };
     environment?: Environment;
+    /**
+     * Optional name of the environment, use for logging
+     */
+    name?: string;
     /**
      * Optional bast url to use for API requests, for example `www.wixapis.com`
      */
@@ -271,6 +275,72 @@ type Except<ObjectType, KeysType extends keyof ObjectType, Options extends Excep
 	? Partial<Record<KeysType, never>>
 	: {});
 
+/**
+Returns a boolean for whether the given type is `never`.
+
+@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
+@link https://stackoverflow.com/a/53984913/10292952
+@link https://www.zhenghao.io/posts/ts-never
+
+Useful in type utilities, such as checking if something does not occur.
+
+@example
+```
+import type {IsNever, And} from 'type-fest';
+
+// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
+type AreStringsEqual<A extends string, B extends string> =
+	And<
+		IsNever<Exclude<A, B>> extends true ? true : false,
+		IsNever<Exclude<B, A>> extends true ? true : false
+	>;
+
+type EndIfEqual<I extends string, O extends string> =
+	AreStringsEqual<I, O> extends true
+		? never
+		: void;
+
+function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
+	if (input === output) {
+		process.exit(0);
+	}
+}
+
+endIfEqual('abc', 'abc');
+//=> never
+
+endIfEqual('abc', '123');
+//=> void
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsNever<T> = [T] extends [never] ? true : false;
+
+/**
+An if-else-like type that resolves depending on whether the given type is `never`.
+
+@see {@link IsNever}
+
+@example
+```
+import type {IfNever} from 'type-fest';
+
+type ShouldBeTrue = IfNever<never>;
+//=> true
+
+type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
+//=> 'bar'
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
+	IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
+);
+
 /**
 Extract the keys from a type where the value type of the key extends the given `Condition`.
 
@@ -303,21 +373,19 @@ type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
 
 @category Object
 */
-type ConditionalKeys<Base, Condition> = NonNullable<
-// Wrap in `NonNullable` to strip away the `undefined` type from the produced union.
+type ConditionalKeys<Base, Condition> =
 {
 	// Map through all the keys of the given base type.
-	[Key in keyof Base]:
+	[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
+	// Retain this key
+	// If the value for the key extends never, only include it if `Condition` also extends never
+		? IfNever<Base[Key], IfNever<Condition, Key, never>, 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]
->;
+}[keyof Base];
 
 /**
 Exclude keys from a shape that matches the given `Condition`.
@@ -800,7 +868,7 @@ interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOpera
     /** id to pass to processing notification */
     correlationId?: string | null;
     /** when event was created / issued */
-    issuedAt?: Date;
+    issuedAt?: Date | null;
 }
 /** @oneof */
 interface UpdateInternalDocumentsEventOperationOneOf {
@@ -1352,6 +1420,8 @@ interface TrendingRequest {
     language?: string | null;
     /** 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 TrendingResponse {
     results?: TrendingItems[];
@@ -1573,6 +1643,8 @@ interface TrendingOptions {
     language?: string | null;
     /** 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[];
 }
 
 declare function search$1(httpClient: HttpClient): SearchSignature;

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

@@ -948,6 +948,8 @@ interface TrendingRequest$1 {
     language?: string | null;
     /** 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 TrendingResponse$1 {
     results?: TrendingItems$1[];
@@ -1369,6 +1371,8 @@ interface TrendingRequest {
     language?: string | null;
     /** 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 TrendingResponse {
     results?: TrendingItems[];