v2.5.2

Support CloudChoice functionality

THIRD-PARTY-NOTICES

@@ -62,7 +62,7 @@ SOFTWARE.
 
 The following NPM package may be included in this product:
 
- - @yext/[email protected].0
+ - @yext/[email protected].4
 
 This package contains the following license and notice below:
 

docs/search-headless.cloudchoice.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [CloudChoice](./search-headless.cloudchoice.md)
+
+## CloudChoice enum
+
+Defines the cloud choice of the API domains.
+
+<b>Signature:</b>
+
+```typescript
+export declare enum CloudChoice 
+```
+
+## Enumeration Members
+
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  GLOBAL\_GCP | <code>&quot;GLOBAL-GCP&quot;</code> |  |
+|  GLOBAL\_MULTI | <code>&quot;GLOBAL-MULTI&quot;</code> |  |
+

docs/search-headless.md

@@ -18,6 +18,7 @@
 |  --- | --- |
 |  [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) applied to a search. |
 |  [BuiltInFieldType](./search-headless.builtinfieldtype.md) | Possible built-in field types for [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md)<!-- -->. |
+|  [CloudChoice](./search-headless.cloudchoice.md) | Defines the cloud choice of the API domains. |
 |  [CloudRegion](./search-headless.cloudregion.md) | Defines the cloud region of the API domains. |
 |  [DirectAnswerType](./search-headless.directanswertype.md) | Represents the type of direct answer. |
 |  [Direction](./search-headless.direction.md) | The direction of a sort. |

docs/search-headless.segment.md

@@ -16,6 +16,7 @@ export declare interface Segment
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [pageNumber?](./search-headless.segment.pagenumber.md) | number | <i>(Optional)</i> The page number of the document that the segment came from. Populated only for pdf files. |
 |  [score](./search-headless.segment.score.md) | number | The similarity score of the segment from 0 to 1 |
 |  [text](./search-headless.segment.text.md) | string | The value of the segment as plain text. |
 

docs/search-headless.segment.pagenumber.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Segment](./search-headless.segment.md) &gt; [pageNumber](./search-headless.segment.pagenumber.md)
+
+## Segment.pageNumber property
+
+The page number of the document that the segment came from. Populated only for pdf files.
+
+<b>Signature:</b>
+
+```typescript
+pageNumber?: number;
+```

docs/search-headless.servingconfig.cloudchoice.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [ServingConfig](./search-headless.servingconfig.md) &gt; [cloudChoice](./search-headless.servingconfig.cloudchoice.md)
+
+## ServingConfig.cloudChoice property
+
+Defines the cloud choice of the API domains.
+
+<b>Signature:</b>
+
+```typescript
+cloudChoice?: CloudChoice;
+```

docs/search-headless.servingconfig.md

@@ -16,6 +16,7 @@ export declare interface ServingConfig
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [cloudChoice?](./search-headless.servingconfig.cloudchoice.md) | [CloudChoice](./search-headless.cloudchoice.md) | <i>(Optional)</i> Defines the cloud choice of the API domains. |
 |  [cloudRegion?](./search-headless.servingconfig.cloudregion.md) | [CloudRegion](./search-headless.cloudregion.md) | <i>(Optional)</i> Defines the cloud region of the API domains. |
 |  [environment?](./search-headless.servingconfig.environment.md) | [Environment](./search-headless.environment.md) | <i>(Optional)</i> Defines the environment of the API domains. |
 

docs/search-headless.source.md

@@ -16,11 +16,8 @@ export declare enum Source
 
 |  Member | Value | Description |
 |  --- | --- | --- |
-|  Algolia | <code>&quot;ALGOLIA&quot;</code> | The result is from Algolia. |
-|  Bing | <code>&quot;BING_CSE&quot;</code> | The result is from Bing Search Engine. |
 |  Custom | <code>&quot;CUSTOM_SEARCHER&quot;</code> | The result was from a custom source. |
 |  DocumentVertical | <code>&quot;DOCUMENT_VERTICAL&quot;</code> | The result is from a document vertical. |
 |  Google | <code>&quot;GOOGLE_CSE&quot;</code> | The result is from Google Custom Search Engine. |
 |  KnowledgeManager | <code>&quot;KNOWLEDGE_MANAGER&quot;</code> | The result is from a Knowledge Graph. |
-|  Zendesk | <code>&quot;ZENDESK&quot;</code> | The result is from Zendesk. |
 

etc/search-headless.api.md

@@ -181,6 +181,14 @@ export interface ClientSDKHeaderValues {
     ANSWERS_CORE?: never;
 }
 
+// @public
+export enum CloudChoice {
+    // (undocumented)
+    GLOBAL_GCP = "GLOBAL-GCP",
+    // (undocumented)
+    GLOBAL_MULTI = "GLOBAL-MULTI"
+}
+
 // @public
 export enum CloudRegion {
     // (undocumented)
@@ -855,6 +863,7 @@ export { searchUtilities }
 
 // @public
 export interface Segment {
+    pageNumber?: number;
     score: number;
     text: string;
 }
@@ -868,6 +877,7 @@ export interface SelectableStaticFilter {
 
 // @public
 export interface ServingConfig {
+    cloudChoice?: CloudChoice;
     cloudRegion?: CloudRegion;
     environment?: Environment;
 }
@@ -903,13 +913,10 @@ export enum SortType {
 
 // @public
 export enum Source {
-    Algolia = "ALGOLIA",
-    Bing = "BING_CSE",
     Custom = "CUSTOM_SEARCHER",
     DocumentVertical = "DOCUMENT_VERTICAL",
     Google = "GOOGLE_CSE",
-    KnowledgeManager = "KNOWLEDGE_MANAGER",
-    Zendesk = "ZENDESK"
+    KnowledgeManager = "KNOWLEDGE_MANAGER"
 }
 
 // @public

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yext/search-headless",
-  "version": "2.5.1",
+  "version": "2.5.2",
   "description": "A library for powering UI components for Yext Search integrations",
   "author": "[email protected]",
   "license": "BSD-3-Clause",
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "@reduxjs/toolkit": "^1.8.1",
-    "@yext/search-core": "^2.5.0",
+    "@yext/search-core": "^2.5.4",
     "js-levenshtein": "^1.1.6",
     "lodash": "^4.17.21"
   },

src/search-core-re-exports.ts

@@ -15,6 +15,7 @@ export {
   ConjunctionStaticFilter,
   Context,
   ClientSDKHeaderValues,
+  CloudChoice,
   CloudRegion,
   Direction,
   DisjunctionStaticFilter,