Merge 2110f30 into da871b1

yext · Jul 12, 2022 · 0127e88 · 0127e88
2 parents da871b1 + 2110f30
commit 0127e88
Show file tree

Hide file tree

Showing 129 changed files with 476 additions and 466 deletions.
diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES
@@ -62,11 +62,11 @@ SOFTWARE.
 
 The following NPM package may be included in this product:
 
- - @yext/answers-core@1.7.0
+ - @yext/search-core@1.8.0
 
 This package contains the following license and notice below:
 
-The Answers Core files listed in this repository are licensed under the below license.  All other features and products are subject to separate agreements
+The Search Core files listed in this repository are licensed under the below license.  All other features and products are subject to separate agreements
 and certain functionality requires paid subscriptions to Yext products.
 
 Contains information from the language-subtag-registry JSON Database (https://github.com/mattcg/language-subtag-registry/tree/master/data/json)

diff --git a/__mocks__/@yext/answers-core.ts b/__mocks__/@yext/answers-core.ts
@@ -1,4 +1,4 @@
-export * from '@yext/answers-core';
+export * from '@yext/search-core';
 
 export function provideCore(): unknown {
   return {

diff --git a/api-extractor.json b/api-extractor.json
@@ -60,7 +60,7 @@
    * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been
    * local files for library1.
    */
-  "bundledPackages": [ "@yext/answers-core" ],
+  "bundledPackages": [ "@yext/search-core" ],
 
   /**
    * Determines how the TypeScript compiler engine will be invoked by API Extractor.

diff --git a/docs/search-headless.additionalhttpheaders._client-sdk_.md b/docs/search-headless.additionalhttpheaders._client-sdk_.md
@@ -4,7 +4,7 @@
 
 ## AdditionalHttpHeaders."Client-SDK" property
 
-Additional agents and their versions used to create the Answers experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent.
+Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent.
 
 <b>Signature:</b>
 

diff --git a/docs/search-headless.additionalhttpheaders.md b/docs/search-headless.additionalhttpheaders.md
@@ -16,5 +16,5 @@ export declare interface AdditionalHttpHeaders
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  ["Client-SDK"?](./search-headless.additionalhttpheaders._client-sdk_.md) | [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | <i>(Optional)</i> Additional agents and their versions used to create the Answers experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. |
+|  ["Client-SDK"?](./search-headless.additionalhttpheaders._client-sdk_.md) | [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | <i>(Optional)</i> Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. |
 
diff --git a/docs/search-headless.answersconfig.md b/docs/search-headless.answersconfig.md
diff --git a/docs/search-headless.answersconfigwithapikey.apikey.md b/docs/search-headless.answersconfigwithapikey.apikey.md
diff --git a/docs/search-headless.answersconfigwithapikey.md b/docs/search-headless.answersconfigwithapikey.md
diff --git a/docs/search-headless.answersconfigwithtoken.md b/docs/search-headless.answersconfigwithtoken.md
diff --git a/docs/search-headless.answersconfigwithtoken.token.md b/docs/search-headless.answersconfigwithtoken.token.md
diff --git a/docs/search-headless.answerscore.md b/docs/search-headless.answerscore.md
diff --git a/docs/search-headless.answerserror.md b/docs/search-headless.answerserror.md
diff --git a/docs/search-headless.answersrequest.md b/docs/search-headless.answersrequest.md
diff --git a/docs/search-headless.appliedqueryfilter.md b/docs/search-headless.appliedqueryfilter.md
@@ -4,7 +4,7 @@
 
 ## AppliedQueryFilter interface
 
-A filter that the Answers API applied to the search.
+A filter that the Search API applied to the search.
 
 <b>Signature:</b>
 

diff --git a/docs/search-headless.autocompleteresponse.inputintents.md b/docs/search-headless.autocompleteresponse.inputintents.md
@@ -4,7 +4,7 @@
 
 ## AutocompleteResponse.inputIntents property
 
-Represents intents from the Answers API.
+Represents intents from the Search API.
 
 <b>Signature:</b>
 

diff --git a/docs/search-headless.autocompleteresponse.md b/docs/search-headless.autocompleteresponse.md
@@ -16,7 +16,7 @@ export declare interface AutocompleteResponse
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [inputIntents](./search-headless.autocompleteresponse.inputintents.md) | [SearchIntent](./search-headless.searchintent.md)<!-- -->\[\] | Represents intents from the Answers API. |
+|  [inputIntents](./search-headless.autocompleteresponse.inputintents.md) | [SearchIntent](./search-headless.searchintent.md)<!-- -->\[\] | Represents intents from the Search API. |
 |  [queryId?](./search-headless.autocompleteresponse.queryid.md) | string | <i>(Optional)</i> The ID of the search query. |
 |  [results](./search-headless.autocompleteresponse.results.md) | [AutocompleteResult](./search-headless.autocompleteresult.md)<!-- -->\[\] | An array of [AutocompleteResult](./search-headless.autocompleteresult.md)<!-- -->s. |
 |  [uuid](./search-headless.autocompleteresponse.uuid.md) | string | A unique id which corresponds to the request. |

diff --git a/docs/search-headless.baseanswersconfig.experiencekey.md b/docs/search-headless.baseanswersconfig.experiencekey.md
diff --git a/docs/search-headless.baseanswersconfig.locale.md b/docs/search-headless.baseanswersconfig.locale.md
diff --git a/docs/search-headless.baseanswersconfig.md b/docs/search-headless.baseanswersconfig.md
diff --git a/...h-headless.baseanswersconfig.endpoints.md → ...ch-headless.basesearchconfig.endpoints.md b/...h-headless.baseanswersconfig.endpoints.md → ...ch-headless.basesearchconfig.endpoints.md
@@ -1,10 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [BaseAnswersConfig](./search-headless.baseanswersconfig.md) &gt; [endpoints](./search-headless.baseanswersconfig.endpoints.md)
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [BaseSearchConfig](./search-headless.basesearchconfig.md) &gt; [endpoints](./search-headless.basesearchconfig.endpoints.md)
 
-## BaseAnswersConfig.endpoints property
+## BaseSearchConfig.endpoints property
 
-Overrides for the URLs which are used when making requests to the Answers API.
+Overrides for the URLs which are used when making requests to the Search API.
 
 <b>Signature:</b>
 

diff --git a/docs/search-headless.basesearchconfig.experiencekey.md b/docs/search-headless.basesearchconfig.experiencekey.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; [BaseSearchConfig](./search-headless.basesearchconfig.md) &gt; [experienceKey](./search-headless.basesearchconfig.experiencekey.md)
+
+## BaseSearchConfig.experienceKey property
+
+The experience key of the search experience.
+
+<b>Signature:</b>
+
+```typescript
+experienceKey: string;
+```
diff --git a/...ss.baseanswersconfig.experienceversion.md → ...ess.basesearchconfig.experienceversion.md b/...ss.baseanswersconfig.experienceversion.md → ...ess.basesearchconfig.experienceversion.md
@@ -1,10 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [BaseAnswersConfig](./search-headless.baseanswersconfig.md) &gt; [experienceVersion](./search-headless.baseanswersconfig.experienceversion.md)
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [BaseSearchConfig](./search-headless.basesearchconfig.md) &gt; [experienceVersion](./search-headless.basesearchconfig.experienceversion.md)
 
-## BaseAnswersConfig.experienceVersion property
+## BaseSearchConfig.experienceVersion property
 
-The version of the answers experience configuration.
+The version of the search experience configuration.
 
 <b>Signature:</b>
 

diff --git a/docs/search-headless.basesearchconfig.locale.md b/docs/search-headless.basesearchconfig.locale.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; [BaseSearchConfig](./search-headless.basesearchconfig.md) &gt; [locale](./search-headless.basesearchconfig.locale.md)
+
+## BaseSearchConfig.locale property
+
+The locale of the search experience.
+
+<b>Signature:</b>
+
+```typescript
+locale: string;
+```
diff --git a/docs/search-headless.basesearchconfig.md b/docs/search-headless.basesearchconfig.md
@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [BaseSearchConfig](./search-headless.basesearchconfig.md)
+
+## BaseSearchConfig interface
+
+The base configuration options for [SearchCore](./search-headless.searchcore.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export declare interface BaseSearchConfig 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [endpoints?](./search-headless.basesearchconfig.endpoints.md) | [Endpoints](./search-headless.endpoints.md) | <i>(Optional)</i> Overrides for the URLs which are used when making requests to the Search API. |
+|  [experienceKey](./search-headless.basesearchconfig.experiencekey.md) | string | The experience key of the search experience. |
+|  [experienceVersion?](./search-headless.basesearchconfig.experienceversion.md) | 'STAGING' \| 'PRODUCTION' \| string \| number | <i>(Optional)</i> The version of the search experience configuration. |
+|  [locale](./search-headless.basesearchconfig.locale.md) | string | The locale of the search experience. |
+|  [visitor?](./search-headless.basesearchconfig.visitor.md) | [Visitor](./search-headless.visitor.md) | <i>(Optional)</i> Information used to associate requests with a particular user. |
+
diff --git a/...rch-headless.baseanswersconfig.visitor.md → ...arch-headless.basesearchconfig.visitor.md b/...rch-headless.baseanswersconfig.visitor.md → ...arch-headless.basesearchconfig.visitor.md
@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [BaseAnswersConfig](./search-headless.baseanswersconfig.md) &gt; [visitor](./search-headless.baseanswersconfig.visitor.md)
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [BaseSearchConfig](./search-headless.basesearchconfig.md) &gt; [visitor](./search-headless.basesearchconfig.visitor.md)
 
-## BaseAnswersConfig.visitor property
+## BaseSearchConfig.visitor property
 
 Information used to associate requests with a particular user.
 

diff --git a/docs/search-headless.clientsdkheadervalues.answers_core.md b/docs/search-headless.clientsdkheadervalues.answers_core.md
@@ -4,7 +4,7 @@
 
 ## ClientSDKHeaderValues.ANSWERS\_CORE property
 
-The ANSWERS\_CORE agent should not be supplied. Instead, it will be automatically added to the header and populated with the version of Answers Core being used.
+The ANSWERS\_CORE agent should not be supplied. Instead, it will be automatically added to the header and populated with the version of Search Core being used.
 
 <b>Signature:</b>