diff --git a/.github/workflows/run-linting.yml b/.github/workflows/run-linting.yml new file mode 100644 index 00000000..94ff0b3e --- /dev/null +++ b/.github/workflows/run-linting.yml @@ -0,0 +1,9 @@ +name: Run Linter + +on: + pull_request: + branches: [master, develop, release/*, hotfix/*] + +jobs: + linting: + uses: yext/slapshot-reusable-workflows/.github/workflows/run-linting.yml@v1 \ No newline at end of file diff --git a/LICENSE b/LICENSE index 8143d033..61d12c4d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -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/README.md b/README.md index 2f407e80..566b05af 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ -# Answers Core +# Search Core
- - NPM version + + NPM version License - - Coverage Status + + Coverage Status

-Answers Core is a networking library for interacting with the Yext Answers API. +Search Core is a networking library for interacting with the Yext Search API. -[Full Documentation](./docs/answers-core.md) +[Full Documentation](./docs/search-core.md) ## Features @@ -29,18 +29,18 @@ Answers Core is a networking library for interacting with the Yext Answers API. For a full getting started walk through, view our [official Hitchhiker Guide](https://hitchhikers.yext.com/guides/answers-core-getting-started/). -First, install Answers-core via [npm](https://www.npmjs.com/get-npm): +First, install Search-core via [npm](https://www.npmjs.com/get-npm): ```bash -npm install @yext/answers-core +npm install @yext/search-core ``` Next, import and initialize the core library in your application. -The apiKey and experienceKey will come from your Answers experience on yext.com. You can signup for a free trial at [https://www.yext.com/free-trial/](https://www.yext.com/free-trial/). +The apiKey and experienceKey will come from your Search experience on yext.com. You can signup for a free trial at [https://www.yext.com/free-trial/](https://www.yext.com/free-trial/). ```js -import { provideCore } from '@yext/answers-core'; +import { provideCore } from '@yext/search-core'; const core = provideCore({ apiKey: '', @@ -52,7 +52,7 @@ const core = provideCore({ To use the library with Node, use the following import instead: ```js -const { provideCore } = require('@yext/answers-core'); +const { provideCore } = require('@yext/search-core'); ``` Now that the core is initialized, let's run a search on an "FAQs" vertical. @@ -60,7 +60,7 @@ Now that the core is initialized, let's run a search on an "FAQs" vertical. ```js core.verticalSearch({ verticalKey: 'FAQs', - query: 'What is Yext Answers?', + query: 'What is Yext Search?', }).then(results => { // Do something with the search results }).catch(err => { @@ -69,16 +69,16 @@ core.verticalSearch({ ``` ### Explanation of Builds -- The ESM (ES6) build will be used automatically by module bundlers that support it (e.g. Webpack). It can be specified directly by importing `@yext/answers-core/lib/esm` -- The CommonJS build will be used automatically by Node, but it can be specified directly by importing `@yext/answers-core/lib/commonjs` -- The Legacy (UMD) bundle should be used for supporting IE11 out of the box. It is compiled to ES5 and it contains the necessary ponyfills for IE11. If your application already contains polyfills, we recommend bundling one of the other builds in order to prevent your application from including duplicate polyfills. This bundle can be specified by importing `@yext/answers-core/legacy` +- The ESM (ES6) build will be used automatically by module bundlers that support it (e.g. Webpack). It can be specified directly by importing `@yext/search-core/lib/esm` +- The CommonJS build will be used automatically by Node, but it can be specified directly by importing `@yext/search-core/lib/commonjs` +- The Legacy (UMD) bundle should be used for supporting IE11 out of the box. It is compiled to ES5 and it contains the necessary ponyfills for IE11. If your application already contains polyfills, we recommend bundling one of the other builds in order to prevent your application from including duplicate polyfills. This bundle can be specified by importing `@yext/search-core/legacy` -And that's it! See **[our documentation](./docs/answers-core.answerscore.md)** for a full list of supported API calls. +And that's it! See **[our documentation](./docs/search-core.searchcore.md)** for a full list of supported API calls. ## License -Yext Answers-core is an open-sourced library licensed under the [BSD-3 License](./LICENSE). +Yext Search-core is an open-sourced library licensed under the [BSD-3 License](./LICENSE). ## Third Party Licenses diff --git a/docs/answers-core.additionalhttpheaders._client-sdk_.md b/docs/answers-core.additionalhttpheaders._client-sdk_.md deleted file mode 100644 index af45629f..00000000 --- a/docs/answers-core.additionalhttpheaders._client-sdk_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AdditionalHttpHeaders](./answers-core.additionalhttpheaders.md) > ["Client-SDK"](./answers-core.additionalhttpheaders._client-sdk_.md) - -## 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. - -Signature: - -```typescript -'Client-SDK'?: ClientSDKHeaderValues; -``` diff --git a/docs/answers-core.additionalhttpheaders.md b/docs/answers-core.additionalhttpheaders.md deleted file mode 100644 index fd4f7bfa..00000000 --- a/docs/answers-core.additionalhttpheaders.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AdditionalHttpHeaders](./answers-core.additionalhttpheaders.md) - -## AdditionalHttpHeaders interface - -AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. - -Signature: - -```typescript -export interface AdditionalHttpHeaders -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| ["Client-SDK"?](./answers-core.additionalhttpheaders._client-sdk_.md) | [ClientSDKHeaderValues](./answers-core.clientsdkheadervalues.md) | (Optional) 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. | - diff --git a/docs/answers-core.answersconfig.md b/docs/answers-core.answersconfig.md deleted file mode 100644 index 37a5e0fe..00000000 --- a/docs/answers-core.answersconfig.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersConfig](./answers-core.answersconfig.md) - -## AnswersConfig type - -The main configuration options for [AnswersCore](./answers-core.answerscore.md). For a full description of the options, see [BaseAnswersConfig](./answers-core.baseanswersconfig.md). The config requires either an apiKey or a token. - -Signature: - -```typescript -export declare type AnswersConfig = AnswersConfigWithApiKey | AnswersConfigWithToken; -``` -References: [AnswersConfigWithApiKey](./answers-core.answersconfigwithapikey.md), [AnswersConfigWithToken](./answers-core.answersconfigwithtoken.md) - diff --git a/docs/answers-core.answersconfigwithapikey.apikey.md b/docs/answers-core.answersconfigwithapikey.apikey.md deleted file mode 100644 index e6f89409..00000000 --- a/docs/answers-core.answersconfigwithapikey.apikey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersConfigWithApiKey](./answers-core.answersconfigwithapikey.md) > [apiKey](./answers-core.answersconfigwithapikey.apikey.md) - -## AnswersConfigWithApiKey.apiKey property - -The api key of the answers experience which will be sent as a query param. - -Signature: - -```typescript -apiKey: string; -``` diff --git a/docs/answers-core.answersconfigwithapikey.md b/docs/answers-core.answersconfigwithapikey.md deleted file mode 100644 index 7b54a6c4..00000000 --- a/docs/answers-core.answersconfigwithapikey.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersConfigWithApiKey](./answers-core.answersconfigwithapikey.md) - -## AnswersConfigWithApiKey interface - -Configuration options for [AnswersCore](./answers-core.answerscore.md), which includes the options from [BaseAnswersConfig](./answers-core.baseanswersconfig.md), but requires apiKey. - -Signature: - -```typescript -export interface AnswersConfigWithApiKey extends BaseAnswersConfig -``` -Extends: [BaseAnswersConfig](./answers-core.baseanswersconfig.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [apiKey](./answers-core.answersconfigwithapikey.apikey.md) | string | The api key of the answers experience which will be sent as a query param. | -| [token?](./answers-core.answersconfigwithapikey.token.md) | never | (Optional) token should NOT be provided along with apiKey. | - diff --git a/docs/answers-core.answersconfigwithapikey.token.md b/docs/answers-core.answersconfigwithapikey.token.md deleted file mode 100644 index 04aaf303..00000000 --- a/docs/answers-core.answersconfigwithapikey.token.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersConfigWithApiKey](./answers-core.answersconfigwithapikey.md) > [token](./answers-core.answersconfigwithapikey.token.md) - -## AnswersConfigWithApiKey.token property - -token should NOT be provided along with apiKey. - -Signature: - -```typescript -token?: never; -``` diff --git a/docs/answers-core.answersconfigwithtoken.apikey.md b/docs/answers-core.answersconfigwithtoken.apikey.md deleted file mode 100644 index 5112db48..00000000 --- a/docs/answers-core.answersconfigwithtoken.apikey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersConfigWithToken](./answers-core.answersconfigwithtoken.md) > [apiKey](./answers-core.answersconfigwithtoken.apikey.md) - -## AnswersConfigWithToken.apiKey property - -apiKey should NOT be provided along with token. - -Signature: - -```typescript -apiKey?: never; -``` diff --git a/docs/answers-core.answersconfigwithtoken.md b/docs/answers-core.answersconfigwithtoken.md deleted file mode 100644 index 1926d385..00000000 --- a/docs/answers-core.answersconfigwithtoken.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersConfigWithToken](./answers-core.answersconfigwithtoken.md) - -## AnswersConfigWithToken interface - -Configuration options for [AnswersCore](./answers-core.answerscore.md), which includes the options from [BaseAnswersConfig](./answers-core.baseanswersconfig.md), but requires token. - -Signature: - -```typescript -export interface AnswersConfigWithToken extends BaseAnswersConfig -``` -Extends: [BaseAnswersConfig](./answers-core.baseanswersconfig.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [apiKey?](./answers-core.answersconfigwithtoken.apikey.md) | never | (Optional) apiKey should NOT be provided along with token. | -| [token](./answers-core.answersconfigwithtoken.token.md) | string | The authentication token of the answers experience which will be passed in the Auth header as a Bearer token. | - diff --git a/docs/answers-core.answersconfigwithtoken.token.md b/docs/answers-core.answersconfigwithtoken.token.md deleted file mode 100644 index f14927b2..00000000 --- a/docs/answers-core.answersconfigwithtoken.token.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersConfigWithToken](./answers-core.answersconfigwithtoken.md) > [token](./answers-core.answersconfigwithtoken.token.md) - -## AnswersConfigWithToken.token property - -The authentication token of the answers experience which will be passed in the Auth header as a Bearer token. - -Signature: - -```typescript -token: string; -``` diff --git a/docs/answers-core.answerscore._constructor_.md b/docs/answers-core.answerscore._constructor_.md deleted file mode 100644 index c333591d..00000000 --- a/docs/answers-core.answerscore._constructor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersCore](./answers-core.answerscore.md) > [(constructor)](./answers-core.answerscore._constructor_.md) - -## AnswersCore.(constructor) - -Constructs a new instance of the `AnswersCore` class - -Signature: - -```typescript -constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| searchService | [SearchService](./answers-core.searchservice.md) | | -| questionSubmissionService | [QuestionSubmissionService](./answers-core.questionsubmissionservice.md) | | -| autoCompleteService | [AutocompleteService](./answers-core.autocompleteservice.md) | | - diff --git a/docs/answers-core.answerscore.md b/docs/answers-core.answerscore.md deleted file mode 100644 index ceb3698d..00000000 --- a/docs/answers-core.answerscore.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersCore](./answers-core.answerscore.md) - -## AnswersCore class - -Provides methods for executing searches, submitting questions, and performing autocompletes. - -Signature: - -```typescript -export declare class AnswersCore -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(searchService, questionSubmissionService, autoCompleteService)](./answers-core.answerscore._constructor_.md) | | Constructs a new instance of the AnswersCore class | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [filterSearch(request)](./answers-core.answerscore.filtersearch.md) | | Performs a filtersearch request against specified fields within a single vertical. | -| [submitQuestion(request)](./answers-core.answerscore.submitquestion.md) | | Submits a custom question to the Answers API. | -| [universalAutocomplete(request)](./answers-core.answerscore.universalautocomplete.md) | | Performs an autocomplete request across all verticals. | -| [universalSearch(request)](./answers-core.answerscore.universalsearch.md) | | Performs an Answers search across all verticals. | -| [verticalAutocomplete(request)](./answers-core.answerscore.verticalautocomplete.md) | | Performs an autocomplete request for a single vertical. | -| [verticalSearch(request)](./answers-core.answerscore.verticalsearch.md) | | Performs an Answers search for a single vertical. | - diff --git a/docs/answers-core.answerscore.submitquestion.md b/docs/answers-core.answerscore.submitquestion.md deleted file mode 100644 index f5411187..00000000 --- a/docs/answers-core.answerscore.submitquestion.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersCore](./answers-core.answerscore.md) > [submitQuestion](./answers-core.answerscore.submitquestion.md) - -## AnswersCore.submitQuestion() method - -Submits a custom question to the Answers API. - -Signature: - -```typescript -submitQuestion(request: QuestionSubmissionRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [QuestionSubmissionRequest](./answers-core.questionsubmissionrequest.md) | Question submission request options | - -Returns: - -Promise<[QuestionSubmissionResponse](./answers-core.questionsubmissionresponse.md)> - -## Remarks - -If rejected, the reason will be an [AnswersError](./answers-core.answerserror.md). - diff --git a/docs/answers-core.answerscore.universalautocomplete.md b/docs/answers-core.answerscore.universalautocomplete.md deleted file mode 100644 index 28c3bc0e..00000000 --- a/docs/answers-core.answerscore.universalautocomplete.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersCore](./answers-core.answerscore.md) > [universalAutocomplete](./answers-core.answerscore.universalautocomplete.md) - -## AnswersCore.universalAutocomplete() method - -Performs an autocomplete request across all verticals. - -Signature: - -```typescript -universalAutocomplete(request: UniversalAutocompleteRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [UniversalAutocompleteRequest](./answers-core.universalautocompleterequest.md) | Universal autocomplete request options | - -Returns: - -Promise<[AutocompleteResponse](./answers-core.autocompleteresponse.md)> - -## Remarks - -If rejected, the reason will be an [AnswersError](./answers-core.answerserror.md). - diff --git a/docs/answers-core.answerscore.universalsearch.md b/docs/answers-core.answerscore.universalsearch.md deleted file mode 100644 index 6fac08d2..00000000 --- a/docs/answers-core.answerscore.universalsearch.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersCore](./answers-core.answerscore.md) > [universalSearch](./answers-core.answerscore.universalsearch.md) - -## AnswersCore.universalSearch() method - -Performs an Answers search across all verticals. - -Signature: - -```typescript -universalSearch(request: UniversalSearchRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [UniversalSearchRequest](./answers-core.universalsearchrequest.md) | Universal search request options | - -Returns: - -Promise<[UniversalSearchResponse](./answers-core.universalsearchresponse.md)> - -## Remarks - -If rejected, the reason will be an [AnswersError](./answers-core.answerserror.md). - diff --git a/docs/answers-core.answerscore.verticalautocomplete.md b/docs/answers-core.answerscore.verticalautocomplete.md deleted file mode 100644 index 16157fb6..00000000 --- a/docs/answers-core.answerscore.verticalautocomplete.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersCore](./answers-core.answerscore.md) > [verticalAutocomplete](./answers-core.answerscore.verticalautocomplete.md) - -## AnswersCore.verticalAutocomplete() method - -Performs an autocomplete request for a single vertical. - -Signature: - -```typescript -verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [VerticalAutocompleteRequest](./answers-core.verticalautocompleterequest.md) | Vertical autocomplete request options | - -Returns: - -Promise<[AutocompleteResponse](./answers-core.autocompleteresponse.md)> - -## Remarks - -If rejected, the reason will be an [AnswersError](./answers-core.answerserror.md). - diff --git a/docs/answers-core.answerscore.verticalsearch.md b/docs/answers-core.answerscore.verticalsearch.md deleted file mode 100644 index 5f3c9e81..00000000 --- a/docs/answers-core.answerscore.verticalsearch.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersCore](./answers-core.answerscore.md) > [verticalSearch](./answers-core.answerscore.verticalsearch.md) - -## AnswersCore.verticalSearch() method - -Performs an Answers search for a single vertical. - -Signature: - -```typescript -verticalSearch(request: VerticalSearchRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) | Vertical search request options | - -Returns: - -Promise<[VerticalSearchResponse](./answers-core.verticalsearchresponse.md)> - -## Remarks - -If rejected, the reason will be an [AnswersError](./answers-core.answerserror.md). - diff --git a/docs/answers-core.answerserror.code.md b/docs/answers-core.answerserror.code.md deleted file mode 100644 index c50fdfd1..00000000 --- a/docs/answers-core.answerserror.code.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersError](./answers-core.answerserror.md) > [code](./answers-core.answerserror.code.md) - -## AnswersError.code property - -Answers API error code. - -Signature: - -```typescript -code?: number; -``` diff --git a/docs/answers-core.answerserror.md b/docs/answers-core.answerserror.md deleted file mode 100644 index 73bddeaa..00000000 --- a/docs/answers-core.answerserror.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersError](./answers-core.answerserror.md) - -## AnswersError class - -Represents an error - -Signature: - -```typescript -export declare class AnswersError extends Error -``` -Extends: Error - -## Remarks - -If the error originates from the Answer API, the code and type property will be present. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AnswersError` class. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [code?](./answers-core.answerserror.code.md) | | number | (Optional) Answers API error code. | -| [message](./answers-core.answerserror.message.md) | | string | The error message. | -| [type?](./answers-core.answerserror.type.md) | | string | (Optional) Answers API error type. | - diff --git a/docs/answers-core.answerserror.message.md b/docs/answers-core.answerserror.message.md deleted file mode 100644 index 65d8b627..00000000 --- a/docs/answers-core.answerserror.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersError](./answers-core.answerserror.md) > [message](./answers-core.answerserror.message.md) - -## AnswersError.message property - -The error message. - -Signature: - -```typescript -message: string; -``` diff --git a/docs/answers-core.answerserror.type.md b/docs/answers-core.answerserror.type.md deleted file mode 100644 index ba87a497..00000000 --- a/docs/answers-core.answerserror.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersError](./answers-core.answerserror.md) > [type](./answers-core.answerserror.type.md) - -## AnswersError.type property - -Answers API error type. - -Signature: - -```typescript -type?: string; -``` diff --git a/docs/answers-core.answersrequest.additionalhttpheaders.md b/docs/answers-core.answersrequest.additionalhttpheaders.md deleted file mode 100644 index 1a3800c1..00000000 --- a/docs/answers-core.answersrequest.additionalhttpheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersRequest](./answers-core.answersrequest.md) > [additionalHttpHeaders](./answers-core.answersrequest.additionalhttpheaders.md) - -## AnswersRequest.additionalHttpHeaders property - -AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. - -Signature: - -```typescript -additionalHttpHeaders?: AdditionalHttpHeaders; -``` diff --git a/docs/answers-core.answersrequest.md b/docs/answers-core.answersrequest.md deleted file mode 100644 index 1b7bf66e..00000000 --- a/docs/answers-core.answersrequest.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersRequest](./answers-core.answersrequest.md) - -## AnswersRequest interface - -Options for an Answers API request. - -Signature: - -```typescript -export interface AnswersRequest -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [additionalHttpHeaders?](./answers-core.answersrequest.additionalhttpheaders.md) | [AdditionalHttpHeaders](./answers-core.additionalhttpheaders.md) | (Optional) AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | - diff --git a/docs/answers-core.appliedqueryfilter.details.md b/docs/answers-core.appliedqueryfilter.details.md deleted file mode 100644 index 0aadb0ce..00000000 --- a/docs/answers-core.appliedqueryfilter.details.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) > [details](./answers-core.appliedqueryfilter.details.md) - -## AppliedQueryFilter.details property - -Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./answers-core.appliedqueryfiltertype.md). - -Signature: - -```typescript -details?: LocationFilterDetails; -``` diff --git a/docs/answers-core.appliedqueryfilter.md b/docs/answers-core.appliedqueryfilter.md deleted file mode 100644 index 9b5a4e0a..00000000 --- a/docs/answers-core.appliedqueryfilter.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) - -## AppliedQueryFilter interface - -A filter that the Answers API applied to the search. - -Signature: - -```typescript -export interface AppliedQueryFilter -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [details?](./answers-core.appliedqueryfilter.details.md) | [LocationFilterDetails](./answers-core.locationfilterdetails.md) | (Optional) Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./answers-core.appliedqueryfiltertype.md). | -| [displayKey](./answers-core.appliedqueryfilter.displaykey.md) | string | The display name of the filter key. | -| [displayValue](./answers-core.appliedqueryfilter.displayvalue.md) | string | The value used in the filter. | -| [filter](./answers-core.appliedqueryfilter.filter.md) | [Filter](./answers-core.filter.md) | The filter applied to the query results. | -| [type](./answers-core.appliedqueryfilter.type.md) | [AppliedQueryFilterType](./answers-core.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) applied to a search. | - diff --git a/docs/answers-core.appliedqueryfilter.type.md b/docs/answers-core.appliedqueryfilter.type.md deleted file mode 100644 index a1ebd908..00000000 --- a/docs/answers-core.appliedqueryfilter.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) > [type](./answers-core.appliedqueryfilter.type.md) - -## AppliedQueryFilter.type property - -Represents the type of [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) applied to a search. - -Signature: - -```typescript -type: AppliedQueryFilterType; -``` diff --git a/docs/answers-core.autocompleteresponse.inputintents.md b/docs/answers-core.autocompleteresponse.inputintents.md deleted file mode 100644 index 35a761b2..00000000 --- a/docs/answers-core.autocompleteresponse.inputintents.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResponse](./answers-core.autocompleteresponse.md) > [inputIntents](./answers-core.autocompleteresponse.inputintents.md) - -## AutocompleteResponse.inputIntents property - -Represents intents from the Answers API. - -Signature: - -```typescript -inputIntents: SearchIntent[]; -``` diff --git a/docs/answers-core.autocompleteresponse.md b/docs/answers-core.autocompleteresponse.md deleted file mode 100644 index bf93ec8d..00000000 --- a/docs/answers-core.autocompleteresponse.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResponse](./answers-core.autocompleteresponse.md) - -## AutocompleteResponse interface - -The response of a universal or vertical autocomplete request. - -Signature: - -```typescript -export interface AutocompleteResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [inputIntents](./answers-core.autocompleteresponse.inputintents.md) | [SearchIntent](./answers-core.searchintent.md)\[\] | Represents intents from the Answers API. | -| [queryId?](./answers-core.autocompleteresponse.queryid.md) | string | (Optional) The ID of the search query. | -| [results](./answers-core.autocompleteresponse.results.md) | [AutocompleteResult](./answers-core.autocompleteresult.md)\[\] | An array of [AutocompleteResult](./answers-core.autocompleteresult.md)s. | -| [uuid](./answers-core.autocompleteresponse.uuid.md) | string | A unique id which corresponds to the request. | - diff --git a/docs/answers-core.autocompleteresponse.results.md b/docs/answers-core.autocompleteresponse.results.md deleted file mode 100644 index fcdb6530..00000000 --- a/docs/answers-core.autocompleteresponse.results.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResponse](./answers-core.autocompleteresponse.md) > [results](./answers-core.autocompleteresponse.results.md) - -## AutocompleteResponse.results property - -An array of [AutocompleteResult](./answers-core.autocompleteresult.md)s. - -Signature: - -```typescript -results: AutocompleteResult[]; -``` diff --git a/docs/answers-core.autocompleteresult.md b/docs/answers-core.autocompleteresult.md deleted file mode 100644 index 7c98f3f7..00000000 --- a/docs/answers-core.autocompleteresult.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResult](./answers-core.autocompleteresult.md) - -## AutocompleteResult interface - -An autocomplete suggestion. - -Signature: - -```typescript -export interface AutocompleteResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [filter?](./answers-core.autocompleteresult.filter.md) | [Filter](./answers-core.filter.md) | (Optional) A filter applied to the autocomplete response. | -| [key?](./answers-core.autocompleteresult.key.md) | string | (Optional) The fieldId which corresponds to the AutocompleteResult value. | -| [matchedSubstrings?](./answers-core.autocompleteresult.matchedsubstrings.md) | { length: number; offset: number; }\[\] | (Optional) An array of substrings which overlap with the autocomplete input. | -| [relatedItem?](./answers-core.autocompleteresult.relateditem.md) | [Result](./answers-core.result.md) | (Optional) An entity that corresponds to the autocomplete result. | -| [value](./answers-core.autocompleteresult.value.md) | string | The value of an autocomplete suggestion. | -| [verticalKeys?](./answers-core.autocompleteresult.verticalkeys.md) | string\[\] | (Optional) Any vertical keys associated with a prompt. This only shows up on universal autocomplete requests. | - diff --git a/docs/answers-core.autocompleteservice.filtersearch.md b/docs/answers-core.autocompleteservice.filtersearch.md deleted file mode 100644 index c96eaaed..00000000 --- a/docs/answers-core.autocompleteservice.filtersearch.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteService](./answers-core.autocompleteservice.md) > [filterSearch](./answers-core.autocompleteservice.filtersearch.md) - -## AutocompleteService.filterSearch() method - -Retrieves query suggestions for filter search. - -Signature: - -```typescript -filterSearch(request: FilterSearchRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [FilterSearchRequest](./answers-core.filtersearchrequest.md) | | - -Returns: - -Promise<[FilterSearchResponse](./answers-core.filtersearchresponse.md)> - diff --git a/docs/answers-core.autocompleteservice.md b/docs/answers-core.autocompleteservice.md deleted file mode 100644 index 1cc417f2..00000000 --- a/docs/answers-core.autocompleteservice.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteService](./answers-core.autocompleteservice.md) - -## AutocompleteService interface - -A service for autocomplete requests. - -Signature: - -```typescript -export interface AutocompleteService -``` - -## Methods - -| Method | Description | -| --- | --- | -| [filterSearch(request)](./answers-core.autocompleteservice.filtersearch.md) | Retrieves query suggestions for filter search. | -| [universalAutocomplete(request)](./answers-core.autocompleteservice.universalautocomplete.md) | Retrieves query suggestions for universal. | -| [verticalAutocomplete(request)](./answers-core.autocompleteservice.verticalautocomplete.md) | Retrieves query suggestions for a vertical. | - diff --git a/docs/answers-core.autocompleteservice.universalautocomplete.md b/docs/answers-core.autocompleteservice.universalautocomplete.md deleted file mode 100644 index b050bf9d..00000000 --- a/docs/answers-core.autocompleteservice.universalautocomplete.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteService](./answers-core.autocompleteservice.md) > [universalAutocomplete](./answers-core.autocompleteservice.universalautocomplete.md) - -## AutocompleteService.universalAutocomplete() method - -Retrieves query suggestions for universal. - -Signature: - -```typescript -universalAutocomplete(request: UniversalAutocompleteRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [UniversalAutocompleteRequest](./answers-core.universalautocompleterequest.md) | | - -Returns: - -Promise<[AutocompleteResponse](./answers-core.autocompleteresponse.md)> - diff --git a/docs/answers-core.autocompleteservice.verticalautocomplete.md b/docs/answers-core.autocompleteservice.verticalautocomplete.md deleted file mode 100644 index 30d899d0..00000000 --- a/docs/answers-core.autocompleteservice.verticalautocomplete.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteService](./answers-core.autocompleteservice.md) > [verticalAutocomplete](./answers-core.autocompleteservice.verticalautocomplete.md) - -## AutocompleteService.verticalAutocomplete() method - -Retrieves query suggestions for a vertical. - -Signature: - -```typescript -verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [VerticalAutocompleteRequest](./answers-core.verticalautocompleterequest.md) | | - -Returns: - -Promise<[AutocompleteResponse](./answers-core.autocompleteresponse.md)> - diff --git a/docs/answers-core.baseanswersconfig.endpoints.md b/docs/answers-core.baseanswersconfig.endpoints.md deleted file mode 100644 index bf94ba86..00000000 --- a/docs/answers-core.baseanswersconfig.endpoints.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [BaseAnswersConfig](./answers-core.baseanswersconfig.md) > [endpoints](./answers-core.baseanswersconfig.endpoints.md) - -## BaseAnswersConfig.endpoints property - -Overrides for the URLs which are used when making requests to the Answers API. - -Signature: - -```typescript -endpoints?: Endpoints; -``` diff --git a/docs/answers-core.baseanswersconfig.experiencekey.md b/docs/answers-core.baseanswersconfig.experiencekey.md deleted file mode 100644 index cd2f7b12..00000000 --- a/docs/answers-core.baseanswersconfig.experiencekey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [BaseAnswersConfig](./answers-core.baseanswersconfig.md) > [experienceKey](./answers-core.baseanswersconfig.experiencekey.md) - -## BaseAnswersConfig.experienceKey property - -The experience key of the answers experience. - -Signature: - -```typescript -experienceKey: string; -``` diff --git a/docs/answers-core.baseanswersconfig.experienceversion.md b/docs/answers-core.baseanswersconfig.experienceversion.md deleted file mode 100644 index 84a6a03c..00000000 --- a/docs/answers-core.baseanswersconfig.experienceversion.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [BaseAnswersConfig](./answers-core.baseanswersconfig.md) > [experienceVersion](./answers-core.baseanswersconfig.experienceversion.md) - -## BaseAnswersConfig.experienceVersion property - -The version of the answers experience configuration. - -Signature: - -```typescript -experienceVersion?: 'STAGING' | 'PRODUCTION' | string | number; -``` - -## Remarks - -May be a configuration label (string) or a configuration version (number). - -## Example - -Examples: 'PRODUCTION', 42 - diff --git a/docs/answers-core.baseanswersconfig.locale.md b/docs/answers-core.baseanswersconfig.locale.md deleted file mode 100644 index 603d1798..00000000 --- a/docs/answers-core.baseanswersconfig.locale.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [BaseAnswersConfig](./answers-core.baseanswersconfig.md) > [locale](./answers-core.baseanswersconfig.locale.md) - -## BaseAnswersConfig.locale property - -The locale of the answers experience. - -Signature: - -```typescript -locale: string; -``` diff --git a/docs/answers-core.baseanswersconfig.md b/docs/answers-core.baseanswersconfig.md deleted file mode 100644 index 9c70a59a..00000000 --- a/docs/answers-core.baseanswersconfig.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [BaseAnswersConfig](./answers-core.baseanswersconfig.md) - -## BaseAnswersConfig interface - -The base configuration options for [AnswersCore](./answers-core.answerscore.md). - -Signature: - -```typescript -export interface BaseAnswersConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [endpoints?](./answers-core.baseanswersconfig.endpoints.md) | [Endpoints](./answers-core.endpoints.md) | (Optional) Overrides for the URLs which are used when making requests to the Answers API. | -| [experienceKey](./answers-core.baseanswersconfig.experiencekey.md) | string | The experience key of the answers experience. | -| [experienceVersion?](./answers-core.baseanswersconfig.experienceversion.md) | 'STAGING' \| 'PRODUCTION' \| string \| number | (Optional) The version of the answers experience configuration. | -| [locale](./answers-core.baseanswersconfig.locale.md) | string | The locale of the answers experience. | -| [visitor?](./answers-core.baseanswersconfig.visitor.md) | [Visitor](./answers-core.visitor.md) | (Optional) Information used to associate requests with a particular user. | - diff --git a/docs/answers-core.clientsdkheadervalues.md b/docs/answers-core.clientsdkheadervalues.md deleted file mode 100644 index eaa21721..00000000 --- a/docs/answers-core.clientsdkheadervalues.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [ClientSDKHeaderValues](./answers-core.clientsdkheadervalues.md) - -## ClientSDKHeaderValues interface - -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. - -Signature: - -```typescript -export interface ClientSDKHeaderValues -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [ANSWERS\_CORE?](./answers-core.clientsdkheadervalues.answers_core.md) | never | (Optional) 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. | - diff --git a/docs/answers-core.combinedfilter.md b/docs/answers-core.combinedfilter.md deleted file mode 100644 index 5f3beec4..00000000 --- a/docs/answers-core.combinedfilter.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [CombinedFilter](./answers-core.combinedfilter.md) - -## CombinedFilter interface - -Represents multiple filters that will be combined to refine results. - -Signature: - -```typescript -export interface CombinedFilter -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [combinator](./answers-core.combinedfilter.combinator.md) | [FilterCombinator](./answers-core.filtercombinator.md) | The logical operator used to combine the filters. | -| [filters](./answers-core.combinedfilter.filters.md) | ([Filter](./answers-core.filter.md) \| [CombinedFilter](./answers-core.combinedfilter.md))\[\] | An array of filters applied to the search. | - diff --git a/docs/answers-core.context.md b/docs/answers-core.context.md deleted file mode 100644 index e4e61724..00000000 --- a/docs/answers-core.context.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Context](./answers-core.context.md) - -## Context type - -Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). - -Signature: - -```typescript -export declare type Context = any; -``` - -## Remarks - -May be any valid JSON object - diff --git a/docs/answers-core.directanswer.md b/docs/answers-core.directanswer.md deleted file mode 100644 index 0fc56257..00000000 --- a/docs/answers-core.directanswer.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DirectAnswer](./answers-core.directanswer.md) - -## DirectAnswer interface - -A direct answer to a search. - -Signature: - -```typescript -export interface DirectAnswer -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldType](./answers-core.directanswer.fieldtype.md) | string | The field type of the direct answer. | -| [relatedResult](./answers-core.directanswer.relatedresult.md) | [Result](./answers-core.result.md) | The entity associated with the direct answer. | -| [type](./answers-core.directanswer.type.md) | [DirectAnswerType](./answers-core.directanswertype.md) | The [DirectAnswerType](./answers-core.directanswertype.md). | -| [value?](./answers-core.directanswer.value.md) | string | (Optional) The result of the direct answer. | -| [verticalKey](./answers-core.directanswer.verticalkey.md) | string | The vertical key of the direct answer. | - diff --git a/docs/answers-core.directanswer.type.md b/docs/answers-core.directanswer.type.md deleted file mode 100644 index df3c81a4..00000000 --- a/docs/answers-core.directanswer.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DirectAnswer](./answers-core.directanswer.md) > [type](./answers-core.directanswer.type.md) - -## DirectAnswer.type property - -The [DirectAnswerType](./answers-core.directanswertype.md). - -Signature: - -```typescript -type: DirectAnswerType; -``` diff --git a/docs/answers-core.directanswer.value.md b/docs/answers-core.directanswer.value.md deleted file mode 100644 index 577ac8de..00000000 --- a/docs/answers-core.directanswer.value.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DirectAnswer](./answers-core.directanswer.md) > [value](./answers-core.directanswer.value.md) - -## DirectAnswer.value property - -The result of the direct answer. - -Signature: - -```typescript -value?: string; -``` - -## Remarks - -A value will not be present if the [DirectAnswer.fieldType](./answers-core.directanswer.fieldtype.md) is 'rich\_text'. - diff --git a/docs/answers-core.displayablefacet.md b/docs/answers-core.displayablefacet.md deleted file mode 100644 index e140563a..00000000 --- a/docs/answers-core.displayablefacet.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DisplayableFacet](./answers-core.displayablefacet.md) - -## DisplayableFacet interface - -A [Facet](./answers-core.facet.md) which contains extra fields meant to be displayed to the end user. - -Signature: - -```typescript -export interface DisplayableFacet extends Facet -``` -Extends: [Facet](./answers-core.facet.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [displayName](./answers-core.displayablefacet.displayname.md) | string | The name of the facet which is meant to be displayed to the user. | -| [fieldId](./answers-core.displayablefacet.fieldid.md) | string | The associated fieldId. | -| [options](./answers-core.displayablefacet.options.md) | [DisplayableFacetOption](./answers-core.displayablefacetoption.md)\[\] | An array of [DisplayableFacetOption](./answers-core.displayablefacetoption.md) | - diff --git a/docs/answers-core.displayablefacet.options.md b/docs/answers-core.displayablefacet.options.md deleted file mode 100644 index 9087df2c..00000000 --- a/docs/answers-core.displayablefacet.options.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DisplayableFacet](./answers-core.displayablefacet.md) > [options](./answers-core.displayablefacet.options.md) - -## DisplayableFacet.options property - -An array of [DisplayableFacetOption](./answers-core.displayablefacetoption.md) - -Signature: - -```typescript -options: DisplayableFacetOption[]; -``` diff --git a/docs/answers-core.displayablefacetoption.md b/docs/answers-core.displayablefacetoption.md deleted file mode 100644 index aa392b8d..00000000 --- a/docs/answers-core.displayablefacetoption.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DisplayableFacetOption](./answers-core.displayablefacetoption.md) - -## DisplayableFacetOption interface - -A [FacetOption](./answers-core.facetoption.md) with extra data meant to be displayed to the end user. - -Signature: - -```typescript -export interface DisplayableFacetOption extends FacetOption -``` -Extends: [FacetOption](./answers-core.facetoption.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [count](./answers-core.displayablefacetoption.count.md) | number | The number of results associated with this facet option. | -| [displayName](./answers-core.displayablefacetoption.displayname.md) | string | The name of the facet option which is meant to be displayed to the end user. | -| [matcher](./answers-core.displayablefacetoption.matcher.md) | [Matcher](./answers-core.matcher.md) | A Matcher is a filtering operation. | -| [selected](./answers-core.displayablefacetoption.selected.md) | boolean | Whether or not the filter is selected in the search results. | -| [value](./answers-core.displayablefacetoption.value.md) | string \| number \| boolean \| [NumberRangeValue](./answers-core.numberrangevalue.md) | The value to compare. | - diff --git a/docs/answers-core.endpoints.filtersearch.md b/docs/answers-core.endpoints.filtersearch.md deleted file mode 100644 index b5bc90e1..00000000 --- a/docs/answers-core.endpoints.filtersearch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Endpoints](./answers-core.endpoints.md) > [filterSearch](./answers-core.endpoints.filtersearch.md) - -## Endpoints.filterSearch property - -Signature: - -```typescript -filterSearch?: string; -``` diff --git a/docs/answers-core.endpoints.md b/docs/answers-core.endpoints.md deleted file mode 100644 index 13274216..00000000 --- a/docs/answers-core.endpoints.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Endpoints](./answers-core.endpoints.md) - -## Endpoints interface - -Overrides for the URLs which are used when making requests to the Answers API. - -Signature: - -```typescript -export interface Endpoints -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [filterSearch?](./answers-core.endpoints.filtersearch.md) | string | (Optional) | -| [questionSubmission?](./answers-core.endpoints.questionsubmission.md) | string | (Optional) | -| [status?](./answers-core.endpoints.status.md) | string | (Optional) | -| [universalAutocomplete?](./answers-core.endpoints.universalautocomplete.md) | string | (Optional) | -| [universalSearch?](./answers-core.endpoints.universalsearch.md) | string | (Optional) | -| [verticalAutocomplete?](./answers-core.endpoints.verticalautocomplete.md) | string | (Optional) | -| [verticalSearch?](./answers-core.endpoints.verticalsearch.md) | string | (Optional) | - diff --git a/docs/answers-core.endpoints.questionsubmission.md b/docs/answers-core.endpoints.questionsubmission.md deleted file mode 100644 index ae3b9f41..00000000 --- a/docs/answers-core.endpoints.questionsubmission.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Endpoints](./answers-core.endpoints.md) > [questionSubmission](./answers-core.endpoints.questionsubmission.md) - -## Endpoints.questionSubmission property - -Signature: - -```typescript -questionSubmission?: string; -``` diff --git a/docs/answers-core.endpoints.status.md b/docs/answers-core.endpoints.status.md deleted file mode 100644 index 22e3e75e..00000000 --- a/docs/answers-core.endpoints.status.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Endpoints](./answers-core.endpoints.md) > [status](./answers-core.endpoints.status.md) - -## Endpoints.status property - -Signature: - -```typescript -status?: string; -``` diff --git a/docs/answers-core.endpoints.universalautocomplete.md b/docs/answers-core.endpoints.universalautocomplete.md deleted file mode 100644 index a72dcfd2..00000000 --- a/docs/answers-core.endpoints.universalautocomplete.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Endpoints](./answers-core.endpoints.md) > [universalAutocomplete](./answers-core.endpoints.universalautocomplete.md) - -## Endpoints.universalAutocomplete property - -Signature: - -```typescript -universalAutocomplete?: string; -``` diff --git a/docs/answers-core.endpoints.universalsearch.md b/docs/answers-core.endpoints.universalsearch.md deleted file mode 100644 index b6e50828..00000000 --- a/docs/answers-core.endpoints.universalsearch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Endpoints](./answers-core.endpoints.md) > [universalSearch](./answers-core.endpoints.universalsearch.md) - -## Endpoints.universalSearch property - -Signature: - -```typescript -universalSearch?: string; -``` diff --git a/docs/answers-core.endpoints.verticalautocomplete.md b/docs/answers-core.endpoints.verticalautocomplete.md deleted file mode 100644 index 8d72f3df..00000000 --- a/docs/answers-core.endpoints.verticalautocomplete.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Endpoints](./answers-core.endpoints.md) > [verticalAutocomplete](./answers-core.endpoints.verticalautocomplete.md) - -## Endpoints.verticalAutocomplete property - -Signature: - -```typescript -verticalAutocomplete?: string; -``` diff --git a/docs/answers-core.endpoints.verticalsearch.md b/docs/answers-core.endpoints.verticalsearch.md deleted file mode 100644 index 350fa045..00000000 --- a/docs/answers-core.endpoints.verticalsearch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Endpoints](./answers-core.endpoints.md) > [verticalSearch](./answers-core.endpoints.verticalsearch.md) - -## Endpoints.verticalSearch property - -Signature: - -```typescript -verticalSearch?: string; -``` diff --git a/docs/answers-core.facet.md b/docs/answers-core.facet.md deleted file mode 100644 index 9a6066d9..00000000 --- a/docs/answers-core.facet.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Facet](./answers-core.facet.md) - -## Facet interface - -Represents dynamic filter options for the Answers API. - -Signature: - -```typescript -export interface Facet -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldId](./answers-core.facet.fieldid.md) | string | The associated fieldId. | -| [options](./answers-core.facet.options.md) | [FacetOption](./answers-core.facetoption.md)\[\] | An array of [FacetOption](./answers-core.facetoption.md) | - diff --git a/docs/answers-core.facetoption.md b/docs/answers-core.facetoption.md deleted file mode 100644 index 65b637dd..00000000 --- a/docs/answers-core.facetoption.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FacetOption](./answers-core.facetoption.md) - -## FacetOption interface - -A filter associated with the facet. - -Signature: - -```typescript -export interface FacetOption -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [matcher](./answers-core.facetoption.matcher.md) | [Matcher](./answers-core.matcher.md) | A Matcher is a filtering operation. | -| [value](./answers-core.facetoption.value.md) | string \| number \| boolean \| [NumberRangeValue](./answers-core.numberrangevalue.md) | The value to compare. | - diff --git a/docs/answers-core.failedvertical.md b/docs/answers-core.failedvertical.md deleted file mode 100644 index e7a2e308..00000000 --- a/docs/answers-core.failedvertical.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FailedVertical](./answers-core.failedvertical.md) - -## FailedVertical interface - -Error information from when a vertical fails to return results. - -Signature: - -```typescript -export interface FailedVertical -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [details](./answers-core.failedvertical.details.md) | { responseCode: number; description: string; } | Detailed information about the error. | -| [errorType](./answers-core.failedvertical.errortype.md) | [ErrorType](./answers-core.errortype.md) | Identifier for the type of error causing the failure. | -| [queryDurationMillis](./answers-core.failedvertical.querydurationmillis.md) | number | The duration of the query in milliseconds. | -| [verticalKey](./answers-core.failedvertical.verticalkey.md) | string | The vertical key associated with the failed vertical. | - diff --git a/docs/answers-core.featuredsnippetdirectanswer.fieldtype.md b/docs/answers-core.featuredsnippetdirectanswer.fieldtype.md deleted file mode 100644 index 82121e61..00000000 --- a/docs/answers-core.featuredsnippetdirectanswer.fieldtype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) > [fieldType](./answers-core.featuredsnippetdirectanswer.fieldtype.md) - -## FeaturedSnippetDirectAnswer.fieldType property - -The field type of the direct answer. - -Signature: - -```typescript -fieldType: string; -``` diff --git a/docs/answers-core.featuredsnippetdirectanswer.md b/docs/answers-core.featuredsnippetdirectanswer.md deleted file mode 100644 index 55ec9647..00000000 --- a/docs/answers-core.featuredsnippetdirectanswer.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) - -## FeaturedSnippetDirectAnswer interface - -A direct answer which was found within a document. - -Signature: - -```typescript -export interface FeaturedSnippetDirectAnswer extends DirectAnswer -``` -Extends: [DirectAnswer](./answers-core.directanswer.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldType](./answers-core.featuredsnippetdirectanswer.fieldtype.md) | string | The field type of the direct answer. | -| [relatedResult](./answers-core.featuredsnippetdirectanswer.relatedresult.md) | [Result](./answers-core.result.md) | The entity associated with the direct answer. | -| [snippet](./answers-core.featuredsnippetdirectanswer.snippet.md) | [Snippet](./answers-core.snippet.md) | The snippet where the direct answer was found. | -| [type](./answers-core.featuredsnippetdirectanswer.type.md) | [DirectAnswerType.FeaturedSnippet](./answers-core.directanswertype.md) | [DirectAnswerType](./answers-core.directanswertype.md).FeaturedSnippet. | -| [value?](./answers-core.featuredsnippetdirectanswer.value.md) | string | (Optional) The result of the direct answer. | -| [verticalKey](./answers-core.featuredsnippetdirectanswer.verticalkey.md) | string | The vertical key of the direct answer. | - diff --git a/docs/answers-core.featuredsnippetdirectanswer.type.md b/docs/answers-core.featuredsnippetdirectanswer.type.md deleted file mode 100644 index 9f353252..00000000 --- a/docs/answers-core.featuredsnippetdirectanswer.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) > [type](./answers-core.featuredsnippetdirectanswer.type.md) - -## FeaturedSnippetDirectAnswer.type property - -[DirectAnswerType](./answers-core.directanswertype.md).FeaturedSnippet. - -Signature: - -```typescript -type: DirectAnswerType.FeaturedSnippet; -``` diff --git a/docs/answers-core.featuredsnippetdirectanswer.value.md b/docs/answers-core.featuredsnippetdirectanswer.value.md deleted file mode 100644 index aa1b14a8..00000000 --- a/docs/answers-core.featuredsnippetdirectanswer.value.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) > [value](./answers-core.featuredsnippetdirectanswer.value.md) - -## FeaturedSnippetDirectAnswer.value property - -The result of the direct answer. - -Signature: - -```typescript -value?: string; -``` - -## Remarks - -A value will not be present if the [DirectAnswer.fieldType](./answers-core.directanswer.fieldtype.md) is 'rich\_text'. - diff --git a/docs/answers-core.featuredsnippetdirectanswer.verticalkey.md b/docs/answers-core.featuredsnippetdirectanswer.verticalkey.md deleted file mode 100644 index f2c035ab..00000000 --- a/docs/answers-core.featuredsnippetdirectanswer.verticalkey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) > [verticalKey](./answers-core.featuredsnippetdirectanswer.verticalkey.md) - -## FeaturedSnippetDirectAnswer.verticalKey property - -The vertical key of the direct answer. - -Signature: - -```typescript -verticalKey: string; -``` diff --git a/docs/answers-core.fieldvaluedirectanswer.md b/docs/answers-core.fieldvaluedirectanswer.md deleted file mode 100644 index ac0bf602..00000000 --- a/docs/answers-core.fieldvaluedirectanswer.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) - -## FieldValueDirectAnswer interface - -A direct answer where the answer came from a field from the knowledge graph. - -Signature: - -```typescript -export interface FieldValueDirectAnswer extends DirectAnswer -``` -Extends: [DirectAnswer](./answers-core.directanswer.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [entityName](./answers-core.fieldvaluedirectanswer.entityname.md) | string | The name of the entity that direct answer came from. | -| [fieldApiName](./answers-core.fieldvaluedirectanswer.fieldapiname.md) | string | The field api name of the direct answer. | -| [fieldName](./answers-core.fieldvaluedirectanswer.fieldname.md) | string | The field name of the direct answer. | -| [fieldType](./answers-core.fieldvaluedirectanswer.fieldtype.md) | string | The field type of the direct answer. | -| [relatedResult](./answers-core.fieldvaluedirectanswer.relatedresult.md) | [Result](./answers-core.result.md) | The entity associated with the direct answer. | -| [type](./answers-core.fieldvaluedirectanswer.type.md) | [DirectAnswerType.FieldValue](./answers-core.directanswertype.md) | [DirectAnswerType](./answers-core.directanswertype.md).FieldValue. | -| [value](./answers-core.fieldvaluedirectanswer.value.md) | string | The result of the direct answer. | -| [verticalKey](./answers-core.fieldvaluedirectanswer.verticalkey.md) | string | The vertical key of the direct answer. | - diff --git a/docs/answers-core.fieldvaluedirectanswer.type.md b/docs/answers-core.fieldvaluedirectanswer.type.md deleted file mode 100644 index aed569cf..00000000 --- a/docs/answers-core.fieldvaluedirectanswer.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) > [type](./answers-core.fieldvaluedirectanswer.type.md) - -## FieldValueDirectAnswer.type property - -[DirectAnswerType](./answers-core.directanswertype.md).FieldValue. - -Signature: - -```typescript -type: DirectAnswerType.FieldValue; -``` diff --git a/docs/answers-core.fieldvaluedirectanswer.value.md b/docs/answers-core.fieldvaluedirectanswer.value.md deleted file mode 100644 index 0d183dd6..00000000 --- a/docs/answers-core.fieldvaluedirectanswer.value.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) > [value](./answers-core.fieldvaluedirectanswer.value.md) - -## FieldValueDirectAnswer.value property - -The result of the direct answer. - -Signature: - -```typescript -value: string; -``` - -## Remarks - -A value will not be present if the [DirectAnswer.fieldType](./answers-core.directanswer.fieldtype.md) is 'rich\_text'. - diff --git a/docs/answers-core.filter.md b/docs/answers-core.filter.md deleted file mode 100644 index fbe0badc..00000000 --- a/docs/answers-core.filter.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Filter](./answers-core.filter.md) - -## Filter interface - -Represents a filter which compares values to a single field. - -Signature: - -```typescript -export interface Filter -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldId](./answers-core.filter.fieldid.md) | string | The fieldId to apply the filter against. | -| [matcher](./answers-core.filter.matcher.md) | [Matcher](./answers-core.matcher.md) | A Matcher is a filtering operation. | -| [value](./answers-core.filter.value.md) | string \| number \| boolean \| [NearFilterValue](./answers-core.nearfiltervalue.md) \| [NumberRangeValue](./answers-core.numberrangevalue.md) | The value to compare. | - diff --git a/docs/answers-core.filtersearchrequest.fields.md b/docs/answers-core.filtersearchrequest.fields.md deleted file mode 100644 index ccd73284..00000000 --- a/docs/answers-core.filtersearchrequest.fields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchRequest](./answers-core.filtersearchrequest.md) > [fields](./answers-core.filtersearchrequest.fields.md) - -## FilterSearchRequest.fields property - -An array of [SearchParameterField](./answers-core.searchparameterfield.md) - -Signature: - -```typescript -fields: SearchParameterField[]; -``` diff --git a/docs/answers-core.filtersearchrequest.md b/docs/answers-core.filtersearchrequest.md deleted file mode 100644 index 212d5c61..00000000 --- a/docs/answers-core.filtersearchrequest.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchRequest](./answers-core.filtersearchrequest.md) - -## FilterSearchRequest interface - -Options for a filtersearch request. - -Signature: - -```typescript -export interface FilterSearchRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-core.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [excluded?](./answers-core.filtersearchrequest.excluded.md) | [Filter](./answers-core.filter.md)\[\] | (Optional) an array of filters that should be excluded from filter search results. | -| [fields](./answers-core.filtersearchrequest.fields.md) | [SearchParameterField](./answers-core.searchparameterfield.md)\[\] | An array of [SearchParameterField](./answers-core.searchparameterfield.md) | -| [input](./answers-core.filtersearchrequest.input.md) | string | The input string for autocomplete. | -| [sectioned](./answers-core.filtersearchrequest.sectioned.md) | boolean | Determines whether or not the results of the [FilterSearchResponse](./answers-core.filtersearchresponse.md) are separated by field. | -| [sessionTrackingEnabled?](./answers-core.filtersearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | -| [verticalKey](./answers-core.filtersearchrequest.verticalkey.md) | string | The key for the vertical to get autocomplete suggestions from. | - diff --git a/docs/answers-core.filtersearchrequest.sectioned.md b/docs/answers-core.filtersearchrequest.sectioned.md deleted file mode 100644 index 1c631e79..00000000 --- a/docs/answers-core.filtersearchrequest.sectioned.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchRequest](./answers-core.filtersearchrequest.md) > [sectioned](./answers-core.filtersearchrequest.sectioned.md) - -## FilterSearchRequest.sectioned property - -Determines whether or not the results of the [FilterSearchResponse](./answers-core.filtersearchresponse.md) are separated by field. - -Signature: - -```typescript -sectioned: boolean; -``` diff --git a/docs/answers-core.filtersearchresponse.businessid.md b/docs/answers-core.filtersearchresponse.businessid.md deleted file mode 100644 index 94d3cd44..00000000 --- a/docs/answers-core.filtersearchresponse.businessid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchResponse](./answers-core.filtersearchresponse.md) > [businessId](./answers-core.filtersearchresponse.businessid.md) - -## FilterSearchResponse.businessId property - -ID of the account associated with this Answers experience - -Signature: - -```typescript -businessId?: string; -``` diff --git a/docs/answers-core.filtersearchresponse.md b/docs/answers-core.filtersearchresponse.md deleted file mode 100644 index 1ca8556d..00000000 --- a/docs/answers-core.filtersearchresponse.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchResponse](./answers-core.filtersearchresponse.md) - -## FilterSearchResponse interface - -The response of a filtersearch request. - -Signature: - -```typescript -export interface FilterSearchResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [businessId?](./answers-core.filtersearchresponse.businessid.md) | string | (Optional) ID of the account associated with this Answers experience | -| [queryId?](./answers-core.filtersearchresponse.queryid.md) | string | (Optional) The ID of the search query. | -| [sections](./answers-core.filtersearchresponse.sections.md) | { label?: string; results: [AutocompleteResult](./answers-core.autocompleteresult.md)\[\]; }\[\] | Represents autocomplete results separated by field. | -| [uuid](./answers-core.filtersearchresponse.uuid.md) | string | A unique id which corresponds to the request. | - diff --git a/docs/answers-core.highlightedvalue.md b/docs/answers-core.highlightedvalue.md deleted file mode 100644 index d99e9998..00000000 --- a/docs/answers-core.highlightedvalue.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [HighlightedValue](./answers-core.highlightedvalue.md) - -## HighlightedValue interface - -A field value and its substring matches as emphasized by the Answers API. - -Signature: - -```typescript -export interface HighlightedValue -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [matchedSubstrings](./answers-core.highlightedvalue.matchedsubstrings.md) | { length: number; offset: number; }\[\] | An array of substring matches which correspond to the highlighting. | -| [value](./answers-core.highlightedvalue.value.md) | string | The value of the field which should be highlighted. | - diff --git a/docs/answers-core.locationbias.md b/docs/answers-core.locationbias.md deleted file mode 100644 index 098e2cc7..00000000 --- a/docs/answers-core.locationbias.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationBias](./answers-core.locationbias.md) - -## LocationBias interface - -Information about the user's location. - -Signature: - -```typescript -export interface LocationBias -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [displayName](./answers-core.locationbias.displayname.md) | string | The name of the location. | -| [latitude](./answers-core.locationbias.latitude.md) | number | The location's latitude. | -| [longitude](./answers-core.locationbias.longitude.md) | number | The location's longitude. | -| [method](./answers-core.locationbias.method.md) | [LocationBiasMethod](./answers-core.locationbiasmethod.md) | The method used to determine the location. | - diff --git a/docs/answers-core.locationboundingbox.md b/docs/answers-core.locationboundingbox.md deleted file mode 100644 index 215e2be5..00000000 --- a/docs/answers-core.locationboundingbox.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationBoundingBox](./answers-core.locationboundingbox.md) - -## LocationBoundingBox interface - -Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./answers-core.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) - -Signature: - -```typescript -export interface LocationBoundingBox -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [maxLatitude](./answers-core.locationboundingbox.maxlatitude.md) | number | The location's highest latitude degree. | -| [maxLongitude](./answers-core.locationboundingbox.maxlongitude.md) | number | The location's highest longitude degree. | -| [minLatitude](./answers-core.locationboundingbox.minlatitude.md) | number | The location's lowest latitude degree. | -| [minLongitude](./answers-core.locationboundingbox.minlongitude.md) | number | The location's lowest longitude degree. | - diff --git a/docs/answers-core.locationfilterdetails.latitude.md b/docs/answers-core.locationfilterdetails.latitude.md deleted file mode 100644 index 364b2b44..00000000 --- a/docs/answers-core.locationfilterdetails.latitude.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationFilterDetails](./answers-core.locationfilterdetails.md) > [latitude](./answers-core.locationfilterdetails.latitude.md) - -## LocationFilterDetails.latitude property - -The location's latitude. - -Signature: - -```typescript -latitude: number; -``` diff --git a/docs/answers-core.locationfilterdetails.longitude.md b/docs/answers-core.locationfilterdetails.longitude.md deleted file mode 100644 index 1d3f1c53..00000000 --- a/docs/answers-core.locationfilterdetails.longitude.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationFilterDetails](./answers-core.locationfilterdetails.md) > [longitude](./answers-core.locationfilterdetails.longitude.md) - -## LocationFilterDetails.longitude property - -The location's longitude. - -Signature: - -```typescript -longitude: number; -``` diff --git a/docs/answers-core.locationfilterdetails.md b/docs/answers-core.locationfilterdetails.md deleted file mode 100644 index 906a0374..00000000 --- a/docs/answers-core.locationfilterdetails.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationFilterDetails](./answers-core.locationfilterdetails.md) - -## LocationFilterDetails interface - -Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./answers-core.appliedqueryfiltertype.md). - -Signature: - -```typescript -export interface LocationFilterDetails -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [boundingBox?](./answers-core.locationfilterdetails.boundingbox.md) | [LocationBoundingBox](./answers-core.locationboundingbox.md) | (Optional) The location's coordinate boundaries. | -| [featureTypes](./answers-core.locationfilterdetails.featuretypes.md) | string\[\] | The location's classification (e.g. locality, region, address). | -| [latitude](./answers-core.locationfilterdetails.latitude.md) | number | The location's latitude. | -| [longitude](./answers-core.locationfilterdetails.longitude.md) | number | The location's longitude. | -| [placeName](./answers-core.locationfilterdetails.placename.md) | string | The location's name. | - diff --git a/docs/answers-core.locationfilterdetails.placename.md b/docs/answers-core.locationfilterdetails.placename.md deleted file mode 100644 index 8d7ee97a..00000000 --- a/docs/answers-core.locationfilterdetails.placename.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationFilterDetails](./answers-core.locationfilterdetails.md) > [placeName](./answers-core.locationfilterdetails.placename.md) - -## LocationFilterDetails.placeName property - -The location's name. - -Signature: - -```typescript -placeName: string; -``` diff --git a/docs/answers-core.lowernumberrangelimit.matcher.md b/docs/answers-core.lowernumberrangelimit.matcher.md deleted file mode 100644 index bf068151..00000000 --- a/docs/answers-core.lowernumberrangelimit.matcher.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LowerNumberRangeLimit](./answers-core.lowernumberrangelimit.md) > [matcher](./answers-core.lowernumberrangelimit.matcher.md) - -## LowerNumberRangeLimit.matcher property - -[Matcher](./answers-core.matcher.md) for the start limit - -Signature: - -```typescript -matcher: Matcher.GreaterThan | Matcher.GreaterThanOrEqualTo; -``` diff --git a/docs/answers-core.lowernumberrangelimit.md b/docs/answers-core.lowernumberrangelimit.md deleted file mode 100644 index b8a4804a..00000000 --- a/docs/answers-core.lowernumberrangelimit.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LowerNumberRangeLimit](./answers-core.lowernumberrangelimit.md) - -## LowerNumberRangeLimit interface - -The start limit of [NumberRangeValue](./answers-core.numberrangevalue.md). - -Signature: - -```typescript -export interface LowerNumberRangeLimit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [matcher](./answers-core.lowernumberrangelimit.matcher.md) | [Matcher.GreaterThan](./answers-core.matcher.md) \| [Matcher.GreaterThanOrEqualTo](./answers-core.matcher.md) | [Matcher](./answers-core.matcher.md) for the start limit | -| [value](./answers-core.lowernumberrangelimit.value.md) | number | Value of the limit. | - diff --git a/docs/answers-core.lowernumberrangelimit.value.md b/docs/answers-core.lowernumberrangelimit.value.md deleted file mode 100644 index 65dd6330..00000000 --- a/docs/answers-core.lowernumberrangelimit.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LowerNumberRangeLimit](./answers-core.lowernumberrangelimit.md) > [value](./answers-core.lowernumberrangelimit.value.md) - -## LowerNumberRangeLimit.value property - -Value of the limit. - -Signature: - -```typescript -value: number; -``` diff --git a/docs/answers-core.md b/docs/answers-core.md deleted file mode 100644 index 680c1216..00000000 --- a/docs/answers-core.md +++ /dev/null @@ -1,107 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) - -## answers-core package - -## Classes - -| Class | Description | -| --- | --- | -| [AnswersCore](./answers-core.answerscore.md) | Provides methods for executing searches, submitting questions, and performing autocompletes. | -| [AnswersError](./answers-core.answerserror.md) | Represents an error | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [AppliedQueryFilterType](./answers-core.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) applied to a search. | -| [DirectAnswerType](./answers-core.directanswertype.md) | Represents the type of direct answer. | -| [Direction](./answers-core.direction.md) | The direction of a sort. | -| [ErrorType](./answers-core.errortype.md) | Identifier for the type of error causing the failure. | -| [FilterCombinator](./answers-core.filtercombinator.md) | Indicates how the filters in a [CombinedFilter](./answers-core.combinedfilter.md) should be combined. | -| [LocationBiasMethod](./answers-core.locationbiasmethod.md) | The method used to determine the location. | -| [Matcher](./answers-core.matcher.md) | A Matcher is a filtering operation. | -| [QuerySource](./answers-core.querysource.md) | The source of the search request. | -| [QueryTrigger](./answers-core.querytrigger.md) | Describes the ways a search can be executed besides user input. | -| [SearchIntent](./answers-core.searchintent.md) | Represents intents from the Answers API. | -| [SortType](./answers-core.sorttype.md) | The method of sorting. | -| [Source](./answers-core.source.md) | Represents the source of a [Result](./answers-core.result.md). | -| [SpellCheckType](./answers-core.spellchecktype.md) | Represents the type of spell check performed. | - -## Functions - -| Function | Description | -| --- | --- | -| [provideCore(config)](./answers-core.providecore.md) | The entrypoint to the answers-core library. | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [AdditionalHttpHeaders](./answers-core.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | -| [AnswersConfigWithApiKey](./answers-core.answersconfigwithapikey.md) | Configuration options for [AnswersCore](./answers-core.answerscore.md), which includes the options from [BaseAnswersConfig](./answers-core.baseanswersconfig.md), but requires apiKey. | -| [AnswersConfigWithToken](./answers-core.answersconfigwithtoken.md) | Configuration options for [AnswersCore](./answers-core.answerscore.md), which includes the options from [BaseAnswersConfig](./answers-core.baseanswersconfig.md), but requires token. | -| [AnswersRequest](./answers-core.answersrequest.md) | Options for an Answers API request. | -| [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) | A filter that the Answers API applied to the search. | -| [AutocompleteResponse](./answers-core.autocompleteresponse.md) | The response of a universal or vertical autocomplete request. | -| [AutocompleteResult](./answers-core.autocompleteresult.md) | An autocomplete suggestion. | -| [AutocompleteService](./answers-core.autocompleteservice.md) | A service for autocomplete requests. | -| [BaseAnswersConfig](./answers-core.baseanswersconfig.md) | The base configuration options for [AnswersCore](./answers-core.answerscore.md). | -| [ClientSDKHeaderValues](./answers-core.clientsdkheadervalues.md) | 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. | -| [CombinedFilter](./answers-core.combinedfilter.md) | Represents multiple filters that will be combined to refine results. | -| [DirectAnswer](./answers-core.directanswer.md) | A direct answer to a search. | -| [DisplayableFacet](./answers-core.displayablefacet.md) | A [Facet](./answers-core.facet.md) which contains extra fields meant to be displayed to the end user. | -| [DisplayableFacetOption](./answers-core.displayablefacetoption.md) | A [FacetOption](./answers-core.facetoption.md) with extra data meant to be displayed to the end user. | -| [Endpoints](./answers-core.endpoints.md) | Overrides for the URLs which are used when making requests to the Answers API. | -| [Facet](./answers-core.facet.md) | Represents dynamic filter options for the Answers API. | -| [FacetOption](./answers-core.facetoption.md) | A filter associated with the facet. | -| [FailedVertical](./answers-core.failedvertical.md) | Error information from when a vertical fails to return results. | -| [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) | A direct answer which was found within a document. | -| [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) | A direct answer where the answer came from a field from the knowledge graph. | -| [Filter](./answers-core.filter.md) | Represents a filter which compares values to a single field. | -| [FilterSearchRequest](./answers-core.filtersearchrequest.md) | Options for a filtersearch request. | -| [FilterSearchResponse](./answers-core.filtersearchresponse.md) | The response of a filtersearch request. | -| [HighlightedValue](./answers-core.highlightedvalue.md) | A field value and its substring matches as emphasized by the Answers API. | -| [LatLong](./answers-core.latlong.md) | The latitude and longitude of the user making the request. Used to bias the results. | -| [LocationBias](./answers-core.locationbias.md) | Information about the user's location. | -| [LocationBoundingBox](./answers-core.locationboundingbox.md) | Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./answers-core.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) | -| [LocationFilterDetails](./answers-core.locationfilterdetails.md) | Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./answers-core.appliedqueryfiltertype.md). | -| [LowerNumberRangeLimit](./answers-core.lowernumberrangelimit.md) | The start limit of [NumberRangeValue](./answers-core.numberrangevalue.md). | -| [NearFilterValue](./answers-core.nearfiltervalue.md) | A filter value for a filter with a $near [Matcher](./answers-core.matcher.md). | -| [NumberRangeValue](./answers-core.numberrangevalue.md) | A filter value for a filter with a $between [Matcher](./answers-core.matcher.md). | -| [QueryRulesActionsData](./answers-core.queryrulesactionsdata.md) | Data returned from the Answers query rules system. | -| [QuestionSubmissionRequest](./answers-core.questionsubmissionrequest.md) | Options for a QuestionSubmission request. | -| [QuestionSubmissionResponse](./answers-core.questionsubmissionresponse.md) | A representation of a question submission response. | -| [QuestionSubmissionService](./answers-core.questionsubmissionservice.md) | Submits a custom question to the Answers API. | -| [Result](./answers-core.result.md) | An individual search result. | -| [SearchParameterField](./answers-core.searchparameterfield.md) | Indicates which entity field to perform the autocomplete request on. | -| [SearchService](./answers-core.searchservice.md) | A service which performs Yext Answers searches | -| [Snippet](./answers-core.snippet.md) | The section of text where a [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) was found. | -| [SortBy](./answers-core.sortby.md) | Represents a criterion that can be used to sort results. | -| [SpellCheck](./answers-core.spellcheck.md) | A spellcheck response from a search query. | -| [UniversalAutocompleteRequest](./answers-core.universalautocompleterequest.md) | Options for a universal autocomplete request. | -| [UniversalLimit](./answers-core.universallimit.md) | The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. | -| [UniversalSearchRequest](./answers-core.universalsearchrequest.md) | Options which can be specified for a universal search. | -| [UniversalSearchResponse](./answers-core.universalsearchresponse.md) | A representation of a response from a universal search. | -| [UpperNumberRangeLimit](./answers-core.uppernumberrangelimit.md) | The end limit of [NumberRangeValue](./answers-core.numberrangevalue.md). | -| [VerticalAutocompleteRequest](./answers-core.verticalautocompleterequest.md) | Options for a vertial autocomplete request. | -| [VerticalResults](./answers-core.verticalresults.md) | Represents results from a search vertical. | -| [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) | Options which can be specified for a vertical search. | -| [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) | A representation of a response from a vertical search. | -| [Visitor](./answers-core.visitor.md) | Information used to associate requests with a particular user. | - -## Variables - -| Variable | Description | -| --- | --- | -| [SandboxEndpoints](./answers-core.sandboxendpoints.md) | The endpoints to use for sandbox experiences. | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [AnswersConfig](./answers-core.answersconfig.md) | The main configuration options for [AnswersCore](./answers-core.answerscore.md). For a full description of the options, see [BaseAnswersConfig](./answers-core.baseanswersconfig.md). The config requires either an apiKey or a token. | -| [Context](./answers-core.context.md) | Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | -| [HighlightedFields](./answers-core.highlightedfields.md) | A mapping of fields to the values emphasized by the Answers API | - diff --git a/docs/answers-core.nearfiltervalue.md b/docs/answers-core.nearfiltervalue.md deleted file mode 100644 index 696b1a1f..00000000 --- a/docs/answers-core.nearfiltervalue.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [NearFilterValue](./answers-core.nearfiltervalue.md) - -## NearFilterValue interface - -A filter value for a filter with a $near [Matcher](./answers-core.matcher.md). - -Signature: - -```typescript -export interface NearFilterValue -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [lat](./answers-core.nearfiltervalue.lat.md) | number | The latitude of the location. | -| [lng](./answers-core.nearfiltervalue.lng.md) | number | The longitude of the location. | -| [radius](./answers-core.nearfiltervalue.radius.md) | number | The radius (in meters) around the latitude and longitude. | - diff --git a/docs/answers-core.numberrangevalue.md b/docs/answers-core.numberrangevalue.md deleted file mode 100644 index c809cca3..00000000 --- a/docs/answers-core.numberrangevalue.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [NumberRangeValue](./answers-core.numberrangevalue.md) - -## NumberRangeValue interface - -A filter value for a filter with a $between [Matcher](./answers-core.matcher.md). - -Signature: - -```typescript -export interface NumberRangeValue -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [end?](./answers-core.numberrangevalue.end.md) | [UpperNumberRangeLimit](./answers-core.uppernumberrangelimit.md) | (Optional) End limit of the number range value. | -| [start?](./answers-core.numberrangevalue.start.md) | [LowerNumberRangeLimit](./answers-core.lowernumberrangelimit.md) | (Optional) Start limit of the number range value. | - diff --git a/docs/answers-core.providecore.md b/docs/answers-core.providecore.md deleted file mode 100644 index b656f02d..00000000 --- a/docs/answers-core.providecore.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [provideCore](./answers-core.providecore.md) - -## provideCore() function - -The entrypoint to the answers-core library. - -Signature: - -```typescript -export declare function provideCore(config: AnswersConfig): AnswersCore; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | [AnswersConfig](./answers-core.answersconfig.md) | The answers-core config | - -Returns: - -[AnswersCore](./answers-core.answerscore.md) - -## Remarks - -Returns an [AnswersCore](./answers-core.answerscore.md) instance. - diff --git a/docs/answers-core.queryrulesactionsdata.md b/docs/answers-core.queryrulesactionsdata.md deleted file mode 100644 index ae8bfd8e..00000000 --- a/docs/answers-core.queryrulesactionsdata.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QueryRulesActionsData](./answers-core.queryrulesactionsdata.md) - -## QueryRulesActionsData interface - -Data returned from the Answers query rules system. - -Signature: - -```typescript -export interface QueryRulesActionsData -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data?](./answers-core.queryrulesactionsdata.data.md) | Record<string, unknown> | (Optional) The data returned from the query rule. | -| [errors?](./answers-core.queryrulesactionsdata.errors.md) | { uuid: string; type: string; message?: string; }\[\] | (Optional) Any errors returned from the query rule. | -| [key](./answers-core.queryrulesactionsdata.key.md) | string | The unique identifier for this query rule. | - diff --git a/docs/answers-core.questionsubmissionrequest.md b/docs/answers-core.questionsubmissionrequest.md deleted file mode 100644 index 710e22a6..00000000 --- a/docs/answers-core.questionsubmissionrequest.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuestionSubmissionRequest](./answers-core.questionsubmissionrequest.md) - -## QuestionSubmissionRequest interface - -Options for a QuestionSubmission request. - -Signature: - -```typescript -export interface QuestionSubmissionRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-core.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [email](./answers-core.questionsubmissionrequest.email.md) | string | The email of the user that is submitting the question. | -| [entityId](./answers-core.questionsubmissionrequest.entityid.md) | string | The ID of the entity to associate with the question. | -| [name](./answers-core.questionsubmissionrequest.name.md) | string | The name of the user. | -| [questionDescription?](./answers-core.questionsubmissionrequest.questiondescription.md) | string | (Optional) Additional information about the question. | -| [questionText](./answers-core.questionsubmissionrequest.questiontext.md) | string | The question. | -| [sessionTrackingEnabled?](./answers-core.questionsubmissionrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | - diff --git a/docs/answers-core.questionsubmissionrequest.name.md b/docs/answers-core.questionsubmissionrequest.name.md deleted file mode 100644 index 1d78ace5..00000000 --- a/docs/answers-core.questionsubmissionrequest.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuestionSubmissionRequest](./answers-core.questionsubmissionrequest.md) > [name](./answers-core.questionsubmissionrequest.name.md) - -## QuestionSubmissionRequest.name property - -The name of the user. - -Signature: - -```typescript -name: string; -``` diff --git a/docs/answers-core.questionsubmissionrequest.questiontext.md b/docs/answers-core.questionsubmissionrequest.questiontext.md deleted file mode 100644 index 5e16cb58..00000000 --- a/docs/answers-core.questionsubmissionrequest.questiontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuestionSubmissionRequest](./answers-core.questionsubmissionrequest.md) > [questionText](./answers-core.questionsubmissionrequest.questiontext.md) - -## QuestionSubmissionRequest.questionText property - -The question. - -Signature: - -```typescript -questionText: string; -``` diff --git a/docs/answers-core.questionsubmissionrequest.sessiontrackingenabled.md b/docs/answers-core.questionsubmissionrequest.sessiontrackingenabled.md deleted file mode 100644 index ee890507..00000000 --- a/docs/answers-core.questionsubmissionrequest.sessiontrackingenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuestionSubmissionRequest](./answers-core.questionsubmissionrequest.md) > [sessionTrackingEnabled](./answers-core.questionsubmissionrequest.sessiontrackingenabled.md) - -## QuestionSubmissionRequest.sessionTrackingEnabled property - -Enables session tracking. - -Signature: - -```typescript -sessionTrackingEnabled?: boolean; -``` diff --git a/docs/answers-core.questionsubmissionservice.md b/docs/answers-core.questionsubmissionservice.md deleted file mode 100644 index 9ea5c00e..00000000 --- a/docs/answers-core.questionsubmissionservice.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuestionSubmissionService](./answers-core.questionsubmissionservice.md) - -## QuestionSubmissionService interface - -Submits a custom question to the Answers API. - -Signature: - -```typescript -export interface QuestionSubmissionService -``` - -## Methods - -| Method | Description | -| --- | --- | -| [submitQuestion(request)](./answers-core.questionsubmissionservice.submitquestion.md) | Submits a question to be answered. | - diff --git a/docs/answers-core.questionsubmissionservice.submitquestion.md b/docs/answers-core.questionsubmissionservice.submitquestion.md deleted file mode 100644 index 17e3915a..00000000 --- a/docs/answers-core.questionsubmissionservice.submitquestion.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuestionSubmissionService](./answers-core.questionsubmissionservice.md) > [submitQuestion](./answers-core.questionsubmissionservice.submitquestion.md) - -## QuestionSubmissionService.submitQuestion() method - -Submits a question to be answered. - -Signature: - -```typescript -submitQuestion(request: QuestionSubmissionRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [QuestionSubmissionRequest](./answers-core.questionsubmissionrequest.md) | The question, as well as the contact info of the submitter. | - -Returns: - -Promise<[QuestionSubmissionResponse](./answers-core.questionsubmissionresponse.md)> - diff --git a/docs/answers-core.result.highlightedfields.md b/docs/answers-core.result.highlightedfields.md deleted file mode 100644 index 6244d275..00000000 --- a/docs/answers-core.result.highlightedfields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) > [highlightedFields](./answers-core.result.highlightedfields.md) - -## Result.highlightedFields property - -The [highlighted fields](./answers-core.highlightedfields.md) emphasized by the api. - -Signature: - -```typescript -highlightedFields?: HighlightedFields; -``` diff --git a/docs/answers-core.result.md b/docs/answers-core.result.md deleted file mode 100644 index 06349bb7..00000000 --- a/docs/answers-core.result.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) - -## Result interface - -An individual search result. - -Signature: - -```typescript -export interface Result -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [description?](./answers-core.result.description.md) | string | (Optional) A description of the result. | -| [distance?](./answers-core.result.distance.md) | number | (Optional) The distance from the user to the result in meters. | -| [distanceFromFilter?](./answers-core.result.distancefromfilter.md) | number | (Optional) The distance from a [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) location to the result in meters. | -| [entityType?](./answers-core.result.entitytype.md) | string | (Optional) The entity type of the result | -| [highlightedFields?](./answers-core.result.highlightedfields.md) | [HighlightedFields](./answers-core.highlightedfields.md) | (Optional) The [highlighted fields](./answers-core.highlightedfields.md) emphasized by the api. | -| [id?](./answers-core.result.id.md) | string | (Optional) The result ID which depends on the Result Source. | -| [index?](./answers-core.result.index.md) | number | (Optional) The index of the result among the other results in the search. | -| [link?](./answers-core.result.link.md) | string | (Optional) A hyperlink associated with the result. | -| [name?](./answers-core.result.name.md) | string | (Optional) The name of the result. | -| [rawData](./answers-core.result.rawdata.md) | Record<string, unknown> | Raw entity profile data in the shape of key-value pairs. | -| [source](./answers-core.result.source.md) | [Source](./answers-core.source.md) | Represents the source of a [Result](./answers-core.result.md). | - diff --git a/docs/answers-core.result.source.md b/docs/answers-core.result.source.md deleted file mode 100644 index 101bf276..00000000 --- a/docs/answers-core.result.source.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) > [source](./answers-core.result.source.md) - -## Result.source property - -Represents the source of a [Result](./answers-core.result.md). - -Signature: - -```typescript -source: Source; -``` diff --git a/docs/answers-core.searchintent.md b/docs/answers-core.searchintent.md deleted file mode 100644 index 758c8caf..00000000 --- a/docs/answers-core.searchintent.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SearchIntent](./answers-core.searchintent.md) - -## SearchIntent enum - -Represents intents from the Answers API. - -Signature: - -```typescript -export declare enum SearchIntent -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| NearMe | "NEAR_ME" | The Answers API is requesting a prompt for the user's location. | - diff --git a/docs/answers-core.searchparameterfield.fetchentities.md b/docs/answers-core.searchparameterfield.fetchentities.md deleted file mode 100644 index 1851518d..00000000 --- a/docs/answers-core.searchparameterfield.fetchentities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SearchParameterField](./answers-core.searchparameterfield.md) > [fetchEntities](./answers-core.searchparameterfield.fetchentities.md) - -## SearchParameterField.fetchEntities property - -Indicates whether or not to return the [AutocompleteResult.relatedItem](./answers-core.autocompleteresult.relateditem.md) associated with the autocomplete result. - -Signature: - -```typescript -fetchEntities: boolean; -``` diff --git a/docs/answers-core.searchparameterfield.md b/docs/answers-core.searchparameterfield.md deleted file mode 100644 index 0303ec18..00000000 --- a/docs/answers-core.searchparameterfield.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SearchParameterField](./answers-core.searchparameterfield.md) - -## SearchParameterField interface - -Indicates which entity field to perform the autocomplete request on. - -Signature: - -```typescript -export interface SearchParameterField -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [entityType](./answers-core.searchparameterfield.entitytype.md) | string | The entityType to perform the autocomplete on. | -| [fetchEntities](./answers-core.searchparameterfield.fetchentities.md) | boolean | Indicates whether or not to return the [AutocompleteResult.relatedItem](./answers-core.autocompleteresult.relateditem.md) associated with the autocomplete result. | -| [fieldApiName](./answers-core.searchparameterfield.fieldapiname.md) | string | The fieldApiName to perform the autocomplete on. | - diff --git a/docs/answers-core.searchservice.md b/docs/answers-core.searchservice.md deleted file mode 100644 index b75f38f1..00000000 --- a/docs/answers-core.searchservice.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SearchService](./answers-core.searchservice.md) - -## SearchService interface - -A service which performs Yext Answers searches - -Signature: - -```typescript -export interface SearchService -``` - -## Methods - -| Method | Description | -| --- | --- | -| [universalSearch(request)](./answers-core.searchservice.universalsearch.md) | Performs a Universal search across all verticals. | -| [verticalSearch(request)](./answers-core.searchservice.verticalsearch.md) | Performs a search across a particular Vertical. | - diff --git a/docs/answers-core.searchservice.universalsearch.md b/docs/answers-core.searchservice.universalsearch.md deleted file mode 100644 index 22646c6c..00000000 --- a/docs/answers-core.searchservice.universalsearch.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SearchService](./answers-core.searchservice.md) > [universalSearch](./answers-core.searchservice.universalsearch.md) - -## SearchService.universalSearch() method - -Performs a Universal search across all verticals. - -Signature: - -```typescript -universalSearch(request: UniversalSearchRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [UniversalSearchRequest](./answers-core.universalsearchrequest.md) | The details of the Universal search request. | - -Returns: - -Promise<[UniversalSearchResponse](./answers-core.universalsearchresponse.md)> - diff --git a/docs/answers-core.searchservice.verticalsearch.md b/docs/answers-core.searchservice.verticalsearch.md deleted file mode 100644 index 0760dc95..00000000 --- a/docs/answers-core.searchservice.verticalsearch.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SearchService](./answers-core.searchservice.md) > [verticalSearch](./answers-core.searchservice.verticalsearch.md) - -## SearchService.verticalSearch() method - -Performs a search across a particular Vertical. - -Signature: - -```typescript -verticalSearch(request: VerticalSearchRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) | The details of the Vertical search request. | - -Returns: - -Promise<[VerticalSearchResponse](./answers-core.verticalsearchresponse.md)> - diff --git a/docs/answers-core.snippet.md b/docs/answers-core.snippet.md deleted file mode 100644 index 65141c47..00000000 --- a/docs/answers-core.snippet.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Snippet](./answers-core.snippet.md) - -## Snippet interface - -The section of text where a [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) was found. - -Signature: - -```typescript -export interface Snippet -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [matchedSubstrings](./answers-core.snippet.matchedsubstrings.md) | { offset: number; length: number; }\[\] | The locations in the document text of the [FeaturedSnippetDirectAnswer.value](./answers-core.featuredsnippetdirectanswer.value.md) | -| [value](./answers-core.snippet.value.md) | string | The snippet's body of text | - diff --git a/docs/answers-core.sortby.md b/docs/answers-core.sortby.md deleted file mode 100644 index 3579d340..00000000 --- a/docs/answers-core.sortby.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SortBy](./answers-core.sortby.md) - -## SortBy interface - -Represents a criterion that can be used to sort results. - -Signature: - -```typescript -export interface SortBy -``` - -## Remarks - -Overrides the sort options that are configured on the experience configuration. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [direction?](./answers-core.sortby.direction.md) | [Direction](./answers-core.direction.md) | (Optional) The direction of the sort. Required if the SortBy type is [SortType.Field](./answers-core.sorttype.md). | -| [field?](./answers-core.sortby.field.md) | string | (Optional) The field name to sort by. Required if the SortBy type is [SortType.Field](./answers-core.sorttype.md). | -| [type](./answers-core.sortby.type.md) | [SortType](./answers-core.sorttype.md) | The method of sorting. | - diff --git a/docs/answers-core.spellcheck.md b/docs/answers-core.spellcheck.md deleted file mode 100644 index ea810125..00000000 --- a/docs/answers-core.spellcheck.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SpellCheck](./answers-core.spellcheck.md) - -## SpellCheck interface - -A spellcheck response from a search query. - -Signature: - -```typescript -export interface SpellCheck -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [correctedQuery](./answers-core.spellcheck.correctedquery.md) | string | The corrected version of the originalQuery. | -| [originalQuery](./answers-core.spellcheck.originalquery.md) | string | The query that was input into the spell checker. | -| [type](./answers-core.spellcheck.type.md) | [SpellCheckType](./answers-core.spellchecktype.md) | The type of spell check. | - diff --git a/docs/answers-core.universalautocompleterequest.input.md b/docs/answers-core.universalautocompleterequest.input.md deleted file mode 100644 index 9256e655..00000000 --- a/docs/answers-core.universalautocompleterequest.input.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalAutocompleteRequest](./answers-core.universalautocompleterequest.md) > [input](./answers-core.universalautocompleterequest.input.md) - -## UniversalAutocompleteRequest.input property - -The input string for autocomplete. - -Signature: - -```typescript -input: string; -``` diff --git a/docs/answers-core.universalautocompleterequest.md b/docs/answers-core.universalautocompleterequest.md deleted file mode 100644 index 6bc155b6..00000000 --- a/docs/answers-core.universalautocompleterequest.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalAutocompleteRequest](./answers-core.universalautocompleterequest.md) - -## UniversalAutocompleteRequest interface - -Options for a universal autocomplete request. - -Signature: - -```typescript -export interface UniversalAutocompleteRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-core.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [input](./answers-core.universalautocompleterequest.input.md) | string | The input string for autocomplete. | -| [sessionTrackingEnabled?](./answers-core.universalautocompleterequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | - diff --git a/docs/answers-core.universalautocompleterequest.sessiontrackingenabled.md b/docs/answers-core.universalautocompleterequest.sessiontrackingenabled.md deleted file mode 100644 index 6130ed49..00000000 --- a/docs/answers-core.universalautocompleterequest.sessiontrackingenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalAutocompleteRequest](./answers-core.universalautocompleterequest.md) > [sessionTrackingEnabled](./answers-core.universalautocompleterequest.sessiontrackingenabled.md) - -## UniversalAutocompleteRequest.sessionTrackingEnabled property - -Enables session tracking. - -Signature: - -```typescript -sessionTrackingEnabled?: boolean; -``` diff --git a/docs/answers-core.universalsearchrequest.context.md b/docs/answers-core.universalsearchrequest.context.md deleted file mode 100644 index 8fe7ab95..00000000 --- a/docs/answers-core.universalsearchrequest.context.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) > [context](./answers-core.universalsearchrequest.context.md) - -## UniversalSearchRequest.context property - -Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). - -Signature: - -```typescript -context?: Context; -``` - -## Remarks - -May be any valid JSON object - diff --git a/docs/answers-core.universalsearchrequest.md b/docs/answers-core.universalsearchrequest.md deleted file mode 100644 index 22405cc4..00000000 --- a/docs/answers-core.universalsearchrequest.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) - -## UniversalSearchRequest interface - -Options which can be specified for a universal search. - -Signature: - -```typescript -export interface UniversalSearchRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-core.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context?](./answers-core.universalsearchrequest.context.md) | [Context](./answers-core.context.md) | (Optional) Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | -| [limit?](./answers-core.universalsearchrequest.limit.md) | [UniversalLimit](./answers-core.universallimit.md) | (Optional) The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. | -| [location?](./answers-core.universalsearchrequest.location.md) | [LatLong](./answers-core.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | -| [query](./answers-core.universalsearchrequest.query.md) | string | The search query. | -| [querySource?](./answers-core.universalsearchrequest.querysource.md) | [QuerySource](./answers-core.querysource.md) \| string | (Optional) The source of the search request. | -| [queryTrigger?](./answers-core.universalsearchrequest.querytrigger.md) | [QueryTrigger](./answers-core.querytrigger.md) | (Optional) Describes the ways a search can be executed besides user input. | -| [referrerPageUrl?](./answers-core.universalsearchrequest.referrerpageurl.md) | string | (Optional) The URl of the page which referred the user to the current page. | -| [restrictVerticals?](./answers-core.universalsearchrequest.restrictverticals.md) | string\[\] | (Optional) If included, the response will only include these verticals. | -| [sessionId?](./answers-core.universalsearchrequest.sessionid.md) | string | (Optional) Used to track session state when cookies are blocked. | -| [sessionTrackingEnabled?](./answers-core.universalsearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | -| [skipSpellCheck?](./answers-core.universalsearchrequest.skipspellcheck.md) | boolean | (Optional) Disables spellcheck if true. | - diff --git a/docs/answers-core.universalsearchrequest.query.md b/docs/answers-core.universalsearchrequest.query.md deleted file mode 100644 index ef5d6d33..00000000 --- a/docs/answers-core.universalsearchrequest.query.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) > [query](./answers-core.universalsearchrequest.query.md) - -## UniversalSearchRequest.query property - -The search query. - -Signature: - -```typescript -query: string; -``` diff --git a/docs/answers-core.universalsearchrequest.sessiontrackingenabled.md b/docs/answers-core.universalsearchrequest.sessiontrackingenabled.md deleted file mode 100644 index 33ce107f..00000000 --- a/docs/answers-core.universalsearchrequest.sessiontrackingenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) > [sessionTrackingEnabled](./answers-core.universalsearchrequest.sessiontrackingenabled.md) - -## UniversalSearchRequest.sessionTrackingEnabled property - -Enables session tracking. - -Signature: - -```typescript -sessionTrackingEnabled?: boolean; -``` diff --git a/docs/answers-core.universalsearchrequest.skipspellcheck.md b/docs/answers-core.universalsearchrequest.skipspellcheck.md deleted file mode 100644 index 788a2295..00000000 --- a/docs/answers-core.universalsearchrequest.skipspellcheck.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) > [skipSpellCheck](./answers-core.universalsearchrequest.skipspellcheck.md) - -## UniversalSearchRequest.skipSpellCheck property - -Disables spellcheck if true. - -Signature: - -```typescript -skipSpellCheck?: boolean; -``` diff --git a/docs/answers-core.universalsearchresponse.md b/docs/answers-core.universalsearchresponse.md deleted file mode 100644 index dd956e9d..00000000 --- a/docs/answers-core.universalsearchresponse.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchResponse](./answers-core.universalsearchresponse.md) - -## UniversalSearchResponse interface - -A representation of a response from a universal search. - -Signature: - -```typescript -export interface UniversalSearchResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [directAnswer?](./answers-core.universalsearchresponse.directanswer.md) | [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) | (Optional) A direct answer to a search. | -| [failedVerticals?](./answers-core.universalsearchresponse.failedverticals.md) | [FailedVertical](./answers-core.failedvertical.md)\[\] | (Optional) Error information from when a vertical fails to return results. | -| [locationBias?](./answers-core.universalsearchresponse.locationbias.md) | [LocationBias](./answers-core.locationbias.md) | (Optional) Information about the user's location. | -| [queryId?](./answers-core.universalsearchresponse.queryid.md) | string | (Optional) The ID of the search query. | -| [queryRulesActionsData?](./answers-core.universalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./answers-core.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Answers query rules system. | -| [searchIntents?](./answers-core.universalsearchresponse.searchintents.md) | [SearchIntent](./answers-core.searchintent.md)\[\] | (Optional) An array of [SearchIntent](./answers-core.searchintent.md)s which represents requests from the API. | -| [spellCheck?](./answers-core.universalsearchresponse.spellcheck.md) | [SpellCheck](./answers-core.spellcheck.md) | (Optional) A spellcheck response from a search query. | -| [uuid](./answers-core.universalsearchresponse.uuid.md) | string | A unique id which corresponds to the request. | -| [verticalResults](./answers-core.universalsearchresponse.verticalresults.md) | [VerticalResults](./answers-core.verticalresults.md)\[\] | An array of [VerticalResults](./answers-core.verticalresults.md) which represent the results for each vertical. | - diff --git a/docs/answers-core.universalsearchresponse.queryid.md b/docs/answers-core.universalsearchresponse.queryid.md deleted file mode 100644 index 88071411..00000000 --- a/docs/answers-core.universalsearchresponse.queryid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchResponse](./answers-core.universalsearchresponse.md) > [queryId](./answers-core.universalsearchresponse.queryid.md) - -## UniversalSearchResponse.queryId property - -The ID of the search query. - -Signature: - -```typescript -queryId?: string; -``` diff --git a/docs/answers-core.universalsearchresponse.queryrulesactionsdata.md b/docs/answers-core.universalsearchresponse.queryrulesactionsdata.md deleted file mode 100644 index dea2fef8..00000000 --- a/docs/answers-core.universalsearchresponse.queryrulesactionsdata.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchResponse](./answers-core.universalsearchresponse.md) > [queryRulesActionsData](./answers-core.universalsearchresponse.queryrulesactionsdata.md) - -## UniversalSearchResponse.queryRulesActionsData property - -Data returned from the Answers query rules system. - -Signature: - -```typescript -queryRulesActionsData?: QueryRulesActionsData[]; -``` diff --git a/docs/answers-core.universalsearchresponse.searchintents.md b/docs/answers-core.universalsearchresponse.searchintents.md deleted file mode 100644 index 045d04c0..00000000 --- a/docs/answers-core.universalsearchresponse.searchintents.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchResponse](./answers-core.universalsearchresponse.md) > [searchIntents](./answers-core.universalsearchresponse.searchintents.md) - -## UniversalSearchResponse.searchIntents property - -An array of [SearchIntent](./answers-core.searchintent.md)s which represents requests from the API. - -Signature: - -```typescript -searchIntents?: SearchIntent[]; -``` diff --git a/docs/answers-core.universalsearchresponse.verticalresults.md b/docs/answers-core.universalsearchresponse.verticalresults.md deleted file mode 100644 index ef93fc2f..00000000 --- a/docs/answers-core.universalsearchresponse.verticalresults.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchResponse](./answers-core.universalsearchresponse.md) > [verticalResults](./answers-core.universalsearchresponse.verticalresults.md) - -## UniversalSearchResponse.verticalResults property - -An array of [VerticalResults](./answers-core.verticalresults.md) which represent the results for each vertical. - -Signature: - -```typescript -verticalResults: VerticalResults[]; -``` diff --git a/docs/answers-core.uppernumberrangelimit.matcher.md b/docs/answers-core.uppernumberrangelimit.matcher.md deleted file mode 100644 index 7d4d708b..00000000 --- a/docs/answers-core.uppernumberrangelimit.matcher.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UpperNumberRangeLimit](./answers-core.uppernumberrangelimit.md) > [matcher](./answers-core.uppernumberrangelimit.matcher.md) - -## UpperNumberRangeLimit.matcher property - -[Matcher](./answers-core.matcher.md) for the end limit - -Signature: - -```typescript -matcher: Matcher.LessThan | Matcher.LessThanOrEqualTo; -``` diff --git a/docs/answers-core.uppernumberrangelimit.md b/docs/answers-core.uppernumberrangelimit.md deleted file mode 100644 index baafaabf..00000000 --- a/docs/answers-core.uppernumberrangelimit.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UpperNumberRangeLimit](./answers-core.uppernumberrangelimit.md) - -## UpperNumberRangeLimit interface - -The end limit of [NumberRangeValue](./answers-core.numberrangevalue.md). - -Signature: - -```typescript -export interface UpperNumberRangeLimit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [matcher](./answers-core.uppernumberrangelimit.matcher.md) | [Matcher.LessThan](./answers-core.matcher.md) \| [Matcher.LessThanOrEqualTo](./answers-core.matcher.md) | [Matcher](./answers-core.matcher.md) for the end limit | -| [value](./answers-core.uppernumberrangelimit.value.md) | number | Value of the limit. | - diff --git a/docs/answers-core.uppernumberrangelimit.value.md b/docs/answers-core.uppernumberrangelimit.value.md deleted file mode 100644 index ef216e9f..00000000 --- a/docs/answers-core.uppernumberrangelimit.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UpperNumberRangeLimit](./answers-core.uppernumberrangelimit.md) > [value](./answers-core.uppernumberrangelimit.value.md) - -## UpperNumberRangeLimit.value property - -Value of the limit. - -Signature: - -```typescript -value: number; -``` diff --git a/docs/answers-core.verticalautocompleterequest.input.md b/docs/answers-core.verticalautocompleterequest.input.md deleted file mode 100644 index b7fcb099..00000000 --- a/docs/answers-core.verticalautocompleterequest.input.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalAutocompleteRequest](./answers-core.verticalautocompleterequest.md) > [input](./answers-core.verticalautocompleterequest.input.md) - -## VerticalAutocompleteRequest.input property - -The input string for autocomplete. - -Signature: - -```typescript -input: string; -``` diff --git a/docs/answers-core.verticalautocompleterequest.md b/docs/answers-core.verticalautocompleterequest.md deleted file mode 100644 index 3ab8d303..00000000 --- a/docs/answers-core.verticalautocompleterequest.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalAutocompleteRequest](./answers-core.verticalautocompleterequest.md) - -## VerticalAutocompleteRequest interface - -Options for a vertial autocomplete request. - -Signature: - -```typescript -export interface VerticalAutocompleteRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-core.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [input](./answers-core.verticalautocompleterequest.input.md) | string | The input string for autocomplete. | -| [sessionTrackingEnabled?](./answers-core.verticalautocompleterequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | -| [verticalKey](./answers-core.verticalautocompleterequest.verticalkey.md) | string | The key for the vertical to get autocomplete suggestions from. | - diff --git a/docs/answers-core.verticalautocompleterequest.sessiontrackingenabled.md b/docs/answers-core.verticalautocompleterequest.sessiontrackingenabled.md deleted file mode 100644 index a6bd1527..00000000 --- a/docs/answers-core.verticalautocompleterequest.sessiontrackingenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalAutocompleteRequest](./answers-core.verticalautocompleterequest.md) > [sessionTrackingEnabled](./answers-core.verticalautocompleterequest.sessiontrackingenabled.md) - -## VerticalAutocompleteRequest.sessionTrackingEnabled property - -Enables session tracking. - -Signature: - -```typescript -sessionTrackingEnabled?: boolean; -``` diff --git a/docs/answers-core.verticalresults.appliedqueryfilters.md b/docs/answers-core.verticalresults.appliedqueryfilters.md deleted file mode 100644 index 24c6d86d..00000000 --- a/docs/answers-core.verticalresults.appliedqueryfilters.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalResults](./answers-core.verticalresults.md) > [appliedQueryFilters](./answers-core.verticalresults.appliedqueryfilters.md) - -## VerticalResults.appliedQueryFilters property - -A array of [AppliedQueryFilter](./answers-core.appliedqueryfilter.md)s which were applied to the vertical results. - -Signature: - -```typescript -appliedQueryFilters: AppliedQueryFilter[]; -``` diff --git a/docs/answers-core.verticalresults.md b/docs/answers-core.verticalresults.md deleted file mode 100644 index 9972f1a8..00000000 --- a/docs/answers-core.verticalresults.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalResults](./answers-core.verticalresults.md) - -## VerticalResults interface - -Represents results from a search vertical. - -Signature: - -```typescript -export interface VerticalResults -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appliedQueryFilters](./answers-core.verticalresults.appliedqueryfilters.md) | [AppliedQueryFilter](./answers-core.appliedqueryfilter.md)\[\] | A array of [AppliedQueryFilter](./answers-core.appliedqueryfilter.md)s which were applied to the vertical results. | -| [queryDurationMillis](./answers-core.verticalresults.querydurationmillis.md) | number | The duration of the query in milliseconds. | -| [results](./answers-core.verticalresults.results.md) | [Result](./answers-core.result.md)\[\] | An array of search [Result](./answers-core.result.md)s for the vertical. | -| [resultsCount](./answers-core.verticalresults.resultscount.md) | number | The total number of results within the vertical. | -| [source](./answers-core.verticalresults.source.md) | [Source](./answers-core.source.md) | Represents the source of a [Result](./answers-core.result.md). | -| [verticalKey](./answers-core.verticalresults.verticalkey.md) | string | The vertical key associated with the vertical results. | - diff --git a/docs/answers-core.verticalresults.results.md b/docs/answers-core.verticalresults.results.md deleted file mode 100644 index 0829464b..00000000 --- a/docs/answers-core.verticalresults.results.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalResults](./answers-core.verticalresults.md) > [results](./answers-core.verticalresults.results.md) - -## VerticalResults.results property - -An array of search [Result](./answers-core.result.md)s for the vertical. - -Signature: - -```typescript -results: Result[]; -``` diff --git a/docs/answers-core.verticalresults.source.md b/docs/answers-core.verticalresults.source.md deleted file mode 100644 index 00c96371..00000000 --- a/docs/answers-core.verticalresults.source.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalResults](./answers-core.verticalresults.md) > [source](./answers-core.verticalresults.source.md) - -## VerticalResults.source property - -Represents the source of a [Result](./answers-core.result.md). - -Signature: - -```typescript -source: Source; -``` diff --git a/docs/answers-core.verticalsearchrequest.context.md b/docs/answers-core.verticalsearchrequest.context.md deleted file mode 100644 index 03b1807f..00000000 --- a/docs/answers-core.verticalsearchrequest.context.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [context](./answers-core.verticalsearchrequest.context.md) - -## VerticalSearchRequest.context property - -Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). - -Signature: - -```typescript -context?: Context; -``` - -## Remarks - -May be any valid JSON object - diff --git a/docs/answers-core.verticalsearchrequest.md b/docs/answers-core.verticalsearchrequest.md deleted file mode 100644 index ffa51a45..00000000 --- a/docs/answers-core.verticalsearchrequest.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) - -## VerticalSearchRequest interface - -Options which can be specified for a vertical search. - -Signature: - -```typescript -export interface VerticalSearchRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-core.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context?](./answers-core.verticalsearchrequest.context.md) | [Context](./answers-core.context.md) | (Optional) Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | -| [facets?](./answers-core.verticalsearchrequest.facets.md) | [Facet](./answers-core.facet.md)\[\] | (Optional) The facet filters to apply to the search. | -| [limit?](./answers-core.verticalsearchrequest.limit.md) | number | (Optional) The maximum number of results to include with a max of 50. | -| [location?](./answers-core.verticalsearchrequest.location.md) | [LatLong](./answers-core.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | -| [locationRadius?](./answers-core.verticalsearchrequest.locationradius.md) | number | (Optional) The radius (in meters) to filter the vertical search by. | -| [offset?](./answers-core.verticalsearchrequest.offset.md) | number | (Optional) The result offset which allows for fetching more results with the same query. | -| [query](./answers-core.verticalsearchrequest.query.md) | string | The search query. | -| [queryId?](./answers-core.verticalsearchrequest.queryid.md) | string | (Optional) The queryId for the query, if this is a repeat query. | -| [querySource?](./answers-core.verticalsearchrequest.querysource.md) | [QuerySource](./answers-core.querysource.md) \| string | (Optional) The source of the search request. | -| [queryTrigger?](./answers-core.verticalsearchrequest.querytrigger.md) | [QueryTrigger](./answers-core.querytrigger.md) | (Optional) Describes the ways a search can be executed besides user input. | -| [referrerPageUrl?](./answers-core.verticalsearchrequest.referrerpageurl.md) | string | (Optional) The URl of the page which referred the user to the current page. | -| [retrieveFacets?](./answers-core.verticalsearchrequest.retrievefacets.md) | boolean | (Optional) Indicates that facets should be retrieved. | -| [sessionId?](./answers-core.verticalsearchrequest.sessionid.md) | string | (Optional) Used to track session state when cookies are blocked. | -| [sessionTrackingEnabled?](./answers-core.verticalsearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | -| [skipSpellCheck?](./answers-core.verticalsearchrequest.skipspellcheck.md) | boolean | (Optional) Skips spell checking if true. | -| [sortBys?](./answers-core.verticalsearchrequest.sortbys.md) | [SortBy](./answers-core.sortby.md)\[\] | (Optional) Determines how results are sorted. \* | -| [staticFilters?](./answers-core.verticalsearchrequest.staticfilters.md) | [CombinedFilter](./answers-core.combinedfilter.md) \| [Filter](./answers-core.filter.md) | (Optional) The static filters to apply to the search. | -| [verticalKey](./answers-core.verticalsearchrequest.verticalkey.md) | string | The key associated with the vertical. | - diff --git a/docs/answers-core.verticalsearchrequest.query.md b/docs/answers-core.verticalsearchrequest.query.md deleted file mode 100644 index 887d064a..00000000 --- a/docs/answers-core.verticalsearchrequest.query.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [query](./answers-core.verticalsearchrequest.query.md) - -## VerticalSearchRequest.query property - -The search query. - -Signature: - -```typescript -query: string; -``` diff --git a/docs/answers-core.verticalsearchrequest.sessiontrackingenabled.md b/docs/answers-core.verticalsearchrequest.sessiontrackingenabled.md deleted file mode 100644 index f2df41e9..00000000 --- a/docs/answers-core.verticalsearchrequest.sessiontrackingenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [sessionTrackingEnabled](./answers-core.verticalsearchrequest.sessiontrackingenabled.md) - -## VerticalSearchRequest.sessionTrackingEnabled property - -Enables session tracking. - -Signature: - -```typescript -sessionTrackingEnabled?: boolean; -``` diff --git a/docs/answers-core.verticalsearchresponse.alternativeverticals.md b/docs/answers-core.verticalsearchresponse.alternativeverticals.md deleted file mode 100644 index ffc991e5..00000000 --- a/docs/answers-core.verticalsearchresponse.alternativeverticals.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) > [alternativeVerticals](./answers-core.verticalsearchresponse.alternativeverticals.md) - -## VerticalSearchResponse.alternativeVerticals property - -The [VerticalResults](./answers-core.verticalresults.md) for each search vertical. - -Signature: - -```typescript -alternativeVerticals?: VerticalResults[]; -``` diff --git a/docs/answers-core.verticalsearchresponse.facets.md b/docs/answers-core.verticalsearchresponse.facets.md deleted file mode 100644 index 02085d61..00000000 --- a/docs/answers-core.verticalsearchresponse.facets.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) > [facets](./answers-core.verticalsearchresponse.facets.md) - -## VerticalSearchResponse.facets property - -An array of [Facet](./answers-core.facet.md)s associated with the search results. - -Signature: - -```typescript -facets?: DisplayableFacet[]; -``` diff --git a/docs/answers-core.verticalsearchresponse.md b/docs/answers-core.verticalsearchresponse.md deleted file mode 100644 index 69d5daed..00000000 --- a/docs/answers-core.verticalsearchresponse.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) - -## VerticalSearchResponse interface - -A representation of a response from a vertical search. - -Signature: - -```typescript -export interface VerticalSearchResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [allResultsForVertical?](./answers-core.verticalsearchresponse.allresultsforvertical.md) | [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) | (Optional) A representation of a response from a vertical search. | -| [alternativeVerticals?](./answers-core.verticalsearchresponse.alternativeverticals.md) | [VerticalResults](./answers-core.verticalresults.md)\[\] | (Optional) The [VerticalResults](./answers-core.verticalresults.md) for each search vertical. | -| [directAnswer?](./answers-core.verticalsearchresponse.directanswer.md) | [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) | (Optional) A direct answer to a search. | -| [facets?](./answers-core.verticalsearchresponse.facets.md) | [DisplayableFacet](./answers-core.displayablefacet.md)\[\] | (Optional) An array of [Facet](./answers-core.facet.md)s associated with the search results. | -| [locationBias?](./answers-core.verticalsearchresponse.locationbias.md) | [LocationBias](./answers-core.locationbias.md) | (Optional) Information about the user's location. | -| [queryId](./answers-core.verticalsearchresponse.queryid.md) | string | The ID of the query. | -| [queryRulesActionsData?](./answers-core.verticalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./answers-core.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Answers query rules system. | -| [searchIntents?](./answers-core.verticalsearchresponse.searchintents.md) | [SearchIntent](./answers-core.searchintent.md)\[\] | (Optional) An array of [SearchIntent](./answers-core.searchintent.md)s. | -| [spellCheck?](./answers-core.verticalsearchresponse.spellcheck.md) | [SpellCheck](./answers-core.spellcheck.md) | (Optional) A spellcheck response from a search query. | -| [uuid](./answers-core.verticalsearchresponse.uuid.md) | string | A unique id which corresponds to the request. | -| [verticalResults](./answers-core.verticalsearchresponse.verticalresults.md) | [VerticalResults](./answers-core.verticalresults.md) | Represents results from a search vertical. | - diff --git a/docs/answers-core.verticalsearchresponse.queryid.md b/docs/answers-core.verticalsearchresponse.queryid.md deleted file mode 100644 index bfa699a0..00000000 --- a/docs/answers-core.verticalsearchresponse.queryid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) > [queryId](./answers-core.verticalsearchresponse.queryid.md) - -## VerticalSearchResponse.queryId property - -The ID of the query. - -Signature: - -```typescript -queryId: string; -``` diff --git a/docs/answers-core.verticalsearchresponse.queryrulesactionsdata.md b/docs/answers-core.verticalsearchresponse.queryrulesactionsdata.md deleted file mode 100644 index 77b92a5a..00000000 --- a/docs/answers-core.verticalsearchresponse.queryrulesactionsdata.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) > [queryRulesActionsData](./answers-core.verticalsearchresponse.queryrulesactionsdata.md) - -## VerticalSearchResponse.queryRulesActionsData property - -Data returned from the Answers query rules system. - -Signature: - -```typescript -queryRulesActionsData?: QueryRulesActionsData[]; -``` diff --git a/docs/answers-core.verticalsearchresponse.searchintents.md b/docs/answers-core.verticalsearchresponse.searchintents.md deleted file mode 100644 index 0efa7734..00000000 --- a/docs/answers-core.verticalsearchresponse.searchintents.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) > [searchIntents](./answers-core.verticalsearchresponse.searchintents.md) - -## VerticalSearchResponse.searchIntents property - -An array of [SearchIntent](./answers-core.searchintent.md)s. - -Signature: - -```typescript -searchIntents?: SearchIntent[]; -``` diff --git a/docs/index.md b/docs/index.md index 5f516755..d3e147bc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,5 +8,5 @@ | Package | Description | | --- | --- | -| [@yext/answers-core](./answers-core.md) | | +| [@yext/search-core](./search-core.md) | | diff --git a/docs/search-core.additionalhttpheaders._client-sdk_.md b/docs/search-core.additionalhttpheaders._client-sdk_.md new file mode 100644 index 00000000..0bd9c67d --- /dev/null +++ b/docs/search-core.additionalhttpheaders._client-sdk_.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AdditionalHttpHeaders](./search-core.additionalhttpheaders.md) > ["Client-SDK"](./search-core.additionalhttpheaders._client-sdk_.md) + +## AdditionalHttpHeaders."Client-SDK" property + +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. + +Signature: + +```typescript +'Client-SDK'?: ClientSDKHeaderValues; +``` diff --git a/docs/search-core.additionalhttpheaders.md b/docs/search-core.additionalhttpheaders.md new file mode 100644 index 00000000..d8331c92 --- /dev/null +++ b/docs/search-core.additionalhttpheaders.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AdditionalHttpHeaders](./search-core.additionalhttpheaders.md) + +## AdditionalHttpHeaders interface + +AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. + +Signature: + +```typescript +export interface AdditionalHttpHeaders +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| ["Client-SDK"?](./search-core.additionalhttpheaders._client-sdk_.md) | [ClientSDKHeaderValues](./search-core.clientsdkheadervalues.md) | (Optional) 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-core.answersconfig.md b/docs/search-core.answersconfig.md new file mode 100644 index 00000000..faf4ecb2 --- /dev/null +++ b/docs/search-core.answersconfig.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AnswersConfig](./search-core.answersconfig.md) + +## AnswersConfig type + +> Warning: This API is now obsolete. +> +> AnswersConfig is deprecated and has been replaced by [SearchConfig](./search-core.searchconfig.md) +> + +Signature: + +```typescript +export declare type AnswersConfig = SearchConfig; +``` +References: [SearchConfig](./search-core.searchconfig.md) + diff --git a/docs/search-core.answersconfigwithapikey.md b/docs/search-core.answersconfigwithapikey.md new file mode 100644 index 00000000..7f1c36c8 --- /dev/null +++ b/docs/search-core.answersconfigwithapikey.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AnswersConfigWithApiKey](./search-core.answersconfigwithapikey.md) + +## AnswersConfigWithApiKey interface + +> Warning: This API is now obsolete. +> +> AnswersConfigWithApiKey is deprecated and has been replaced by [SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md) +> + +Signature: + +```typescript +export interface AnswersConfigWithApiKey extends SearchConfigWithApiKey +``` +Extends: [SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md) + diff --git a/docs/search-core.answersconfigwithtoken.md b/docs/search-core.answersconfigwithtoken.md new file mode 100644 index 00000000..01755fd6 --- /dev/null +++ b/docs/search-core.answersconfigwithtoken.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AnswersConfigWithToken](./search-core.answersconfigwithtoken.md) + +## AnswersConfigWithToken interface + +> Warning: This API is now obsolete. +> +> AnswersConfigWithToken is deprecated and has been replaced by [SearchConfigWithToken](./search-core.searchconfigwithtoken.md) +> + +Signature: + +```typescript +export interface AnswersConfigWithToken extends SearchConfigWithToken +``` +Extends: [SearchConfigWithToken](./search-core.searchconfigwithtoken.md) + diff --git a/docs/search-core.answerscore.md b/docs/search-core.answerscore.md new file mode 100644 index 00000000..bcffe85f --- /dev/null +++ b/docs/search-core.answerscore.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AnswersCore](./search-core.answerscore.md) + +## AnswersCore class + +> Warning: This API is now obsolete. +> +> AnswersCore is deprecated and has been replaced by [SearchCore](./search-core.searchcore.md) +> + +Signature: + +```typescript +export declare class AnswersCore extends SearchCore +``` +Extends: [SearchCore](./search-core.searchcore.md) + diff --git a/docs/search-core.answerserror.md b/docs/search-core.answerserror.md new file mode 100644 index 00000000..4bacf89e --- /dev/null +++ b/docs/search-core.answerserror.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AnswersError](./search-core.answerserror.md) + +## AnswersError interface + +> Warning: This API is now obsolete. +> +> AnswersError is deprecated and has been replaced by [SearchError](./search-core.searcherror.md) +> + +Signature: + +```typescript +export interface AnswersError extends SearchError +``` +Extends: [SearchError](./search-core.searcherror.md) + diff --git a/docs/search-core.answersrequest.md b/docs/search-core.answersrequest.md new file mode 100644 index 00000000..3733c784 --- /dev/null +++ b/docs/search-core.answersrequest.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AnswersRequest](./search-core.answersrequest.md) + +## AnswersRequest interface + +> Warning: This API is now obsolete. +> +> AnswersRequest is deprecated and has been replaced by [SearchRequest](./search-core.searchrequest.md) +> + +Signature: + +```typescript +export interface AnswersRequest extends SearchRequest +``` +Extends: [SearchRequest](./search-core.searchrequest.md) + diff --git a/docs/search-core.appliedqueryfilter.details.md b/docs/search-core.appliedqueryfilter.details.md new file mode 100644 index 00000000..36bcba95 --- /dev/null +++ b/docs/search-core.appliedqueryfilter.details.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AppliedQueryFilter](./search-core.appliedqueryfilter.md) > [details](./search-core.appliedqueryfilter.details.md) + +## AppliedQueryFilter.details property + +Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md). + +Signature: + +```typescript +details?: LocationFilterDetails; +``` diff --git a/docs/answers-core.appliedqueryfilter.displaykey.md b/docs/search-core.appliedqueryfilter.displaykey.md similarity index 53% rename from docs/answers-core.appliedqueryfilter.displaykey.md rename to docs/search-core.appliedqueryfilter.displaykey.md index cd6e1117..1c14c311 100644 --- a/docs/answers-core.appliedqueryfilter.displaykey.md +++ b/docs/search-core.appliedqueryfilter.displaykey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) > [displayKey](./answers-core.appliedqueryfilter.displaykey.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AppliedQueryFilter](./search-core.appliedqueryfilter.md) > [displayKey](./search-core.appliedqueryfilter.displaykey.md) ## AppliedQueryFilter.displayKey property diff --git a/docs/answers-core.appliedqueryfilter.displayvalue.md b/docs/search-core.appliedqueryfilter.displayvalue.md similarity index 52% rename from docs/answers-core.appliedqueryfilter.displayvalue.md rename to docs/search-core.appliedqueryfilter.displayvalue.md index d953caae..9f703118 100644 --- a/docs/answers-core.appliedqueryfilter.displayvalue.md +++ b/docs/search-core.appliedqueryfilter.displayvalue.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) > [displayValue](./answers-core.appliedqueryfilter.displayvalue.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AppliedQueryFilter](./search-core.appliedqueryfilter.md) > [displayValue](./search-core.appliedqueryfilter.displayvalue.md) ## AppliedQueryFilter.displayValue property diff --git a/docs/answers-core.appliedqueryfilter.filter.md b/docs/search-core.appliedqueryfilter.filter.md similarity index 52% rename from docs/answers-core.appliedqueryfilter.filter.md rename to docs/search-core.appliedqueryfilter.filter.md index 9ee38851..8ef7046b 100644 --- a/docs/answers-core.appliedqueryfilter.filter.md +++ b/docs/search-core.appliedqueryfilter.filter.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) > [filter](./answers-core.appliedqueryfilter.filter.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AppliedQueryFilter](./search-core.appliedqueryfilter.md) > [filter](./search-core.appliedqueryfilter.filter.md) ## AppliedQueryFilter.filter property diff --git a/docs/search-core.appliedqueryfilter.md b/docs/search-core.appliedqueryfilter.md new file mode 100644 index 00000000..28cdac0c --- /dev/null +++ b/docs/search-core.appliedqueryfilter.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AppliedQueryFilter](./search-core.appliedqueryfilter.md) + +## AppliedQueryFilter interface + +A filter that the Search API applied to the search. + +Signature: + +```typescript +export interface AppliedQueryFilter +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [details?](./search-core.appliedqueryfilter.details.md) | [LocationFilterDetails](./search-core.locationfilterdetails.md) | (Optional) Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md). | +| [displayKey](./search-core.appliedqueryfilter.displaykey.md) | string | The display name of the filter key. | +| [displayValue](./search-core.appliedqueryfilter.displayvalue.md) | string | The value used in the filter. | +| [filter](./search-core.appliedqueryfilter.filter.md) | [Filter](./search-core.filter.md) | The filter applied to the query results. | +| [type](./search-core.appliedqueryfilter.type.md) | [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./search-core.appliedqueryfilter.md) applied to a search. | + diff --git a/docs/search-core.appliedqueryfilter.type.md b/docs/search-core.appliedqueryfilter.type.md new file mode 100644 index 00000000..4e3b12f6 --- /dev/null +++ b/docs/search-core.appliedqueryfilter.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AppliedQueryFilter](./search-core.appliedqueryfilter.md) > [type](./search-core.appliedqueryfilter.type.md) + +## AppliedQueryFilter.type property + +Represents the type of [AppliedQueryFilter](./search-core.appliedqueryfilter.md) applied to a search. + +Signature: + +```typescript +type: AppliedQueryFilterType; +``` diff --git a/docs/answers-core.appliedqueryfiltertype.md b/docs/search-core.appliedqueryfiltertype.md similarity index 70% rename from docs/answers-core.appliedqueryfiltertype.md rename to docs/search-core.appliedqueryfiltertype.md index ec15e594..571ab645 100644 --- a/docs/answers-core.appliedqueryfiltertype.md +++ b/docs/search-core.appliedqueryfiltertype.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AppliedQueryFilterType](./answers-core.appliedqueryfiltertype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md) ## AppliedQueryFilterType enum -Represents the type of [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) applied to a search. +Represents the type of [AppliedQueryFilter](./search-core.appliedqueryfilter.md) applied to a search. Signature: diff --git a/docs/search-core.autocompleteresponse.inputintents.md b/docs/search-core.autocompleteresponse.inputintents.md new file mode 100644 index 00000000..ca8d81f8 --- /dev/null +++ b/docs/search-core.autocompleteresponse.inputintents.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResponse](./search-core.autocompleteresponse.md) > [inputIntents](./search-core.autocompleteresponse.inputintents.md) + +## AutocompleteResponse.inputIntents property + +Represents intents from the Search API. + +Signature: + +```typescript +inputIntents: SearchIntent[]; +``` diff --git a/docs/search-core.autocompleteresponse.md b/docs/search-core.autocompleteresponse.md new file mode 100644 index 00000000..4df82cff --- /dev/null +++ b/docs/search-core.autocompleteresponse.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResponse](./search-core.autocompleteresponse.md) + +## AutocompleteResponse interface + +The response of a universal or vertical autocomplete request. + +Signature: + +```typescript +export interface AutocompleteResponse +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [inputIntents](./search-core.autocompleteresponse.inputintents.md) | [SearchIntent](./search-core.searchintent.md)\[\] | Represents intents from the Search API. | +| [queryId?](./search-core.autocompleteresponse.queryid.md) | string | (Optional) The ID of the search query. | +| [results](./search-core.autocompleteresponse.results.md) | [AutocompleteResult](./search-core.autocompleteresult.md)\[\] | An array of [AutocompleteResult](./search-core.autocompleteresult.md)s. | +| [uuid](./search-core.autocompleteresponse.uuid.md) | string | A unique id which corresponds to the request. | + diff --git a/docs/answers-core.autocompleteresponse.queryid.md b/docs/search-core.autocompleteresponse.queryid.md similarity index 50% rename from docs/answers-core.autocompleteresponse.queryid.md rename to docs/search-core.autocompleteresponse.queryid.md index e9d2569f..fdf0da53 100644 --- a/docs/answers-core.autocompleteresponse.queryid.md +++ b/docs/search-core.autocompleteresponse.queryid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResponse](./answers-core.autocompleteresponse.md) > [queryId](./answers-core.autocompleteresponse.queryid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResponse](./search-core.autocompleteresponse.md) > [queryId](./search-core.autocompleteresponse.queryid.md) ## AutocompleteResponse.queryId property diff --git a/docs/search-core.autocompleteresponse.results.md b/docs/search-core.autocompleteresponse.results.md new file mode 100644 index 00000000..6badf274 --- /dev/null +++ b/docs/search-core.autocompleteresponse.results.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResponse](./search-core.autocompleteresponse.md) > [results](./search-core.autocompleteresponse.results.md) + +## AutocompleteResponse.results property + +An array of [AutocompleteResult](./search-core.autocompleteresult.md)s. + +Signature: + +```typescript +results: AutocompleteResult[]; +``` diff --git a/docs/answers-core.autocompleteresponse.uuid.md b/docs/search-core.autocompleteresponse.uuid.md similarity index 52% rename from docs/answers-core.autocompleteresponse.uuid.md rename to docs/search-core.autocompleteresponse.uuid.md index 63b7fa2a..d6e3ef08 100644 --- a/docs/answers-core.autocompleteresponse.uuid.md +++ b/docs/search-core.autocompleteresponse.uuid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResponse](./answers-core.autocompleteresponse.md) > [uuid](./answers-core.autocompleteresponse.uuid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResponse](./search-core.autocompleteresponse.md) > [uuid](./search-core.autocompleteresponse.uuid.md) ## AutocompleteResponse.uuid property diff --git a/docs/answers-core.autocompleteresult.filter.md b/docs/search-core.autocompleteresult.filter.md similarity index 58% rename from docs/answers-core.autocompleteresult.filter.md rename to docs/search-core.autocompleteresult.filter.md index c3a958d6..718d2b1f 100644 --- a/docs/answers-core.autocompleteresult.filter.md +++ b/docs/search-core.autocompleteresult.filter.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResult](./answers-core.autocompleteresult.md) > [filter](./answers-core.autocompleteresult.filter.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResult](./search-core.autocompleteresult.md) > [filter](./search-core.autocompleteresult.filter.md) ## AutocompleteResult.filter property diff --git a/docs/answers-core.autocompleteresult.key.md b/docs/search-core.autocompleteresult.key.md similarity index 59% rename from docs/answers-core.autocompleteresult.key.md rename to docs/search-core.autocompleteresult.key.md index d6ea4f69..6ea8dbb8 100644 --- a/docs/answers-core.autocompleteresult.key.md +++ b/docs/search-core.autocompleteresult.key.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResult](./answers-core.autocompleteresult.md) > [key](./answers-core.autocompleteresult.key.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResult](./search-core.autocompleteresult.md) > [key](./search-core.autocompleteresult.key.md) ## AutocompleteResult.key property diff --git a/docs/answers-core.autocompleteresult.matchedsubstrings.md b/docs/search-core.autocompleteresult.matchedsubstrings.md similarity index 65% rename from docs/answers-core.autocompleteresult.matchedsubstrings.md rename to docs/search-core.autocompleteresult.matchedsubstrings.md index 53e16bc2..16443c51 100644 --- a/docs/answers-core.autocompleteresult.matchedsubstrings.md +++ b/docs/search-core.autocompleteresult.matchedsubstrings.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResult](./answers-core.autocompleteresult.md) > [matchedSubstrings](./answers-core.autocompleteresult.matchedsubstrings.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResult](./search-core.autocompleteresult.md) > [matchedSubstrings](./search-core.autocompleteresult.matchedsubstrings.md) ## AutocompleteResult.matchedSubstrings property diff --git a/docs/search-core.autocompleteresult.md b/docs/search-core.autocompleteresult.md new file mode 100644 index 00000000..94ca63cb --- /dev/null +++ b/docs/search-core.autocompleteresult.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResult](./search-core.autocompleteresult.md) + +## AutocompleteResult interface + +An autocomplete suggestion. + +Signature: + +```typescript +export interface AutocompleteResult +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [filter?](./search-core.autocompleteresult.filter.md) | [Filter](./search-core.filter.md) | (Optional) A filter applied to the autocomplete response. | +| [key?](./search-core.autocompleteresult.key.md) | string | (Optional) The fieldId which corresponds to the AutocompleteResult value. | +| [matchedSubstrings?](./search-core.autocompleteresult.matchedsubstrings.md) | { length: number; offset: number; }\[\] | (Optional) An array of substrings which overlap with the autocomplete input. | +| [relatedItem?](./search-core.autocompleteresult.relateditem.md) | [Result](./search-core.result.md) | (Optional) An entity that corresponds to the autocomplete result. | +| [value](./search-core.autocompleteresult.value.md) | string | The value of an autocomplete suggestion. | +| [verticalKeys?](./search-core.autocompleteresult.verticalkeys.md) | string\[\] | (Optional) Any vertical keys associated with a prompt. This only shows up on universal autocomplete requests. | + diff --git a/docs/answers-core.autocompleteresult.relateditem.md b/docs/search-core.autocompleteresult.relateditem.md similarity index 50% rename from docs/answers-core.autocompleteresult.relateditem.md rename to docs/search-core.autocompleteresult.relateditem.md index b212c7a1..11471422 100644 --- a/docs/answers-core.autocompleteresult.relateditem.md +++ b/docs/search-core.autocompleteresult.relateditem.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResult](./answers-core.autocompleteresult.md) > [relatedItem](./answers-core.autocompleteresult.relateditem.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResult](./search-core.autocompleteresult.md) > [relatedItem](./search-core.autocompleteresult.relateditem.md) ## AutocompleteResult.relatedItem property @@ -14,5 +14,5 @@ relatedItem?: Result; ## Remarks -This property is only defined if the corresponding [SearchParameterField.fetchEntities](./answers-core.searchparameterfield.fetchentities.md) field is true. +This property is only defined if the corresponding [SearchParameterField.fetchEntities](./search-core.searchparameterfield.fetchentities.md) field is true. diff --git a/docs/answers-core.autocompleteresult.value.md b/docs/search-core.autocompleteresult.value.md similarity index 52% rename from docs/answers-core.autocompleteresult.value.md rename to docs/search-core.autocompleteresult.value.md index c406e39f..36395bc7 100644 --- a/docs/answers-core.autocompleteresult.value.md +++ b/docs/search-core.autocompleteresult.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResult](./answers-core.autocompleteresult.md) > [value](./answers-core.autocompleteresult.value.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResult](./search-core.autocompleteresult.md) > [value](./search-core.autocompleteresult.value.md) ## AutocompleteResult.value property diff --git a/docs/answers-core.autocompleteresult.verticalkeys.md b/docs/search-core.autocompleteresult.verticalkeys.md similarity index 57% rename from docs/answers-core.autocompleteresult.verticalkeys.md rename to docs/search-core.autocompleteresult.verticalkeys.md index 560bd806..112e6095 100644 --- a/docs/answers-core.autocompleteresult.verticalkeys.md +++ b/docs/search-core.autocompleteresult.verticalkeys.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AutocompleteResult](./answers-core.autocompleteresult.md) > [verticalKeys](./answers-core.autocompleteresult.verticalkeys.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResult](./search-core.autocompleteresult.md) > [verticalKeys](./search-core.autocompleteresult.verticalkeys.md) ## AutocompleteResult.verticalKeys property diff --git a/docs/search-core.autocompleteservice.filtersearch.md b/docs/search-core.autocompleteservice.filtersearch.md new file mode 100644 index 00000000..0e247ad2 --- /dev/null +++ b/docs/search-core.autocompleteservice.filtersearch.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteService](./search-core.autocompleteservice.md) > [filterSearch](./search-core.autocompleteservice.filtersearch.md) + +## AutocompleteService.filterSearch() method + +Retrieves query suggestions for filter search. + +Signature: + +```typescript +filterSearch(request: FilterSearchRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [FilterSearchRequest](./search-core.filtersearchrequest.md) | | + +Returns: + +Promise<[FilterSearchResponse](./search-core.filtersearchresponse.md)> + diff --git a/docs/search-core.autocompleteservice.md b/docs/search-core.autocompleteservice.md new file mode 100644 index 00000000..a0d27ade --- /dev/null +++ b/docs/search-core.autocompleteservice.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteService](./search-core.autocompleteservice.md) + +## AutocompleteService interface + +A service for autocomplete requests. + +Signature: + +```typescript +export interface AutocompleteService +``` + +## Methods + +| Method | Description | +| --- | --- | +| [filterSearch(request)](./search-core.autocompleteservice.filtersearch.md) | Retrieves query suggestions for filter search. | +| [universalAutocomplete(request)](./search-core.autocompleteservice.universalautocomplete.md) | Retrieves query suggestions for universal. | +| [verticalAutocomplete(request)](./search-core.autocompleteservice.verticalautocomplete.md) | Retrieves query suggestions for a vertical. | + diff --git a/docs/search-core.autocompleteservice.universalautocomplete.md b/docs/search-core.autocompleteservice.universalautocomplete.md new file mode 100644 index 00000000..6f236e80 --- /dev/null +++ b/docs/search-core.autocompleteservice.universalautocomplete.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteService](./search-core.autocompleteservice.md) > [universalAutocomplete](./search-core.autocompleteservice.universalautocomplete.md) + +## AutocompleteService.universalAutocomplete() method + +Retrieves query suggestions for universal. + +Signature: + +```typescript +universalAutocomplete(request: UniversalAutocompleteRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [UniversalAutocompleteRequest](./search-core.universalautocompleterequest.md) | | + +Returns: + +Promise<[AutocompleteResponse](./search-core.autocompleteresponse.md)> + diff --git a/docs/search-core.autocompleteservice.verticalautocomplete.md b/docs/search-core.autocompleteservice.verticalautocomplete.md new file mode 100644 index 00000000..f11a3073 --- /dev/null +++ b/docs/search-core.autocompleteservice.verticalautocomplete.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteService](./search-core.autocompleteservice.md) > [verticalAutocomplete](./search-core.autocompleteservice.verticalautocomplete.md) + +## AutocompleteService.verticalAutocomplete() method + +Retrieves query suggestions for a vertical. + +Signature: + +```typescript +verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [VerticalAutocompleteRequest](./search-core.verticalautocompleterequest.md) | | + +Returns: + +Promise<[AutocompleteResponse](./search-core.autocompleteresponse.md)> + diff --git a/docs/search-core.baseanswersconfig.md b/docs/search-core.baseanswersconfig.md new file mode 100644 index 00000000..c40e97d8 --- /dev/null +++ b/docs/search-core.baseanswersconfig.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [BaseAnswersConfig](./search-core.baseanswersconfig.md) + +## BaseAnswersConfig interface + +> Warning: This API is now obsolete. +> +> BaseAnswersConfig is deprecated and has been replaced by [BaseSearchConfig](./search-core.basesearchconfig.md) +> + +Signature: + +```typescript +export interface BaseAnswersConfig extends BaseSearchConfig +``` +Extends: [BaseSearchConfig](./search-core.basesearchconfig.md) + diff --git a/docs/search-core.basesearchconfig.endpoints.md b/docs/search-core.basesearchconfig.endpoints.md new file mode 100644 index 00000000..a71677d7 --- /dev/null +++ b/docs/search-core.basesearchconfig.endpoints.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [BaseSearchConfig](./search-core.basesearchconfig.md) > [endpoints](./search-core.basesearchconfig.endpoints.md) + +## BaseSearchConfig.endpoints property + +Overrides for the URLs which are used when making requests to the Search API. + +Signature: + +```typescript +endpoints?: Endpoints; +``` diff --git a/docs/search-core.basesearchconfig.experiencekey.md b/docs/search-core.basesearchconfig.experiencekey.md new file mode 100644 index 00000000..8a703d89 --- /dev/null +++ b/docs/search-core.basesearchconfig.experiencekey.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [BaseSearchConfig](./search-core.basesearchconfig.md) > [experienceKey](./search-core.basesearchconfig.experiencekey.md) + +## BaseSearchConfig.experienceKey property + +The experience key of the search experience. + +Signature: + +```typescript +experienceKey: string; +``` diff --git a/docs/search-core.basesearchconfig.experienceversion.md b/docs/search-core.basesearchconfig.experienceversion.md new file mode 100644 index 00000000..3740a615 --- /dev/null +++ b/docs/search-core.basesearchconfig.experienceversion.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [BaseSearchConfig](./search-core.basesearchconfig.md) > [experienceVersion](./search-core.basesearchconfig.experienceversion.md) + +## BaseSearchConfig.experienceVersion property + +The version of the search experience configuration. + +Signature: + +```typescript +experienceVersion?: 'STAGING' | 'PRODUCTION' | string | number; +``` + +## Remarks + +May be a configuration label (string) or a configuration version (number). + +## Example + +Examples: 'PRODUCTION', 42 + diff --git a/docs/search-core.basesearchconfig.locale.md b/docs/search-core.basesearchconfig.locale.md new file mode 100644 index 00000000..5858a729 --- /dev/null +++ b/docs/search-core.basesearchconfig.locale.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [BaseSearchConfig](./search-core.basesearchconfig.md) > [locale](./search-core.basesearchconfig.locale.md) + +## BaseSearchConfig.locale property + +The locale of the search experience. + +Signature: + +```typescript +locale: string; +``` diff --git a/docs/search-core.basesearchconfig.md b/docs/search-core.basesearchconfig.md new file mode 100644 index 00000000..8f9407ef --- /dev/null +++ b/docs/search-core.basesearchconfig.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [BaseSearchConfig](./search-core.basesearchconfig.md) + +## BaseSearchConfig interface + +The base configuration options for [SearchCore](./search-core.searchcore.md). + +Signature: + +```typescript +export interface BaseSearchConfig +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [endpoints?](./search-core.basesearchconfig.endpoints.md) | [Endpoints](./search-core.endpoints.md) | (Optional) Overrides for the URLs which are used when making requests to the Search API. | +| [experienceKey](./search-core.basesearchconfig.experiencekey.md) | string | The experience key of the search experience. | +| [experienceVersion?](./search-core.basesearchconfig.experienceversion.md) | 'STAGING' \| 'PRODUCTION' \| string \| number | (Optional) The version of the search experience configuration. | +| [locale](./search-core.basesearchconfig.locale.md) | string | The locale of the search experience. | +| [visitor?](./search-core.basesearchconfig.visitor.md) | [Visitor](./search-core.visitor.md) | (Optional) Information used to associate requests with a particular user. | + diff --git a/docs/answers-core.baseanswersconfig.visitor.md b/docs/search-core.basesearchconfig.visitor.md similarity index 57% rename from docs/answers-core.baseanswersconfig.visitor.md rename to docs/search-core.basesearchconfig.visitor.md index 25d7b6a4..25143be8 100644 --- a/docs/answers-core.baseanswersconfig.visitor.md +++ b/docs/search-core.basesearchconfig.visitor.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [BaseAnswersConfig](./answers-core.baseanswersconfig.md) > [visitor](./answers-core.baseanswersconfig.visitor.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [BaseSearchConfig](./search-core.basesearchconfig.md) > [visitor](./search-core.basesearchconfig.visitor.md) -## BaseAnswersConfig.visitor property +## BaseSearchConfig.visitor property Information used to associate requests with a particular user. diff --git a/docs/answers-core.clientsdkheadervalues.answers_core.md b/docs/search-core.clientsdkheadervalues.answers_core.md similarity index 55% rename from docs/answers-core.clientsdkheadervalues.answers_core.md rename to docs/search-core.clientsdkheadervalues.answers_core.md index 74488e4b..2879d8ce 100644 --- a/docs/answers-core.clientsdkheadervalues.answers_core.md +++ b/docs/search-core.clientsdkheadervalues.answers_core.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [ClientSDKHeaderValues](./answers-core.clientsdkheadervalues.md) > [ANSWERS\_CORE](./answers-core.clientsdkheadervalues.answers_core.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [ClientSDKHeaderValues](./search-core.clientsdkheadervalues.md) > [ANSWERS\_CORE](./search-core.clientsdkheadervalues.answers_core.md) ## 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. Signature: diff --git a/docs/search-core.clientsdkheadervalues.md b/docs/search-core.clientsdkheadervalues.md new file mode 100644 index 00000000..a289299b --- /dev/null +++ b/docs/search-core.clientsdkheadervalues.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [ClientSDKHeaderValues](./search-core.clientsdkheadervalues.md) + +## ClientSDKHeaderValues interface + +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. + +Signature: + +```typescript +export interface ClientSDKHeaderValues +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [ANSWERS\_CORE?](./search-core.clientsdkheadervalues.answers_core.md) | never | (Optional) 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. | + diff --git a/docs/answers-core.combinedfilter.combinator.md b/docs/search-core.combinedfilter.combinator.md similarity index 55% rename from docs/answers-core.combinedfilter.combinator.md rename to docs/search-core.combinedfilter.combinator.md index 7877dc02..ff0853f5 100644 --- a/docs/answers-core.combinedfilter.combinator.md +++ b/docs/search-core.combinedfilter.combinator.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [CombinedFilter](./answers-core.combinedfilter.md) > [combinator](./answers-core.combinedfilter.combinator.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [CombinedFilter](./search-core.combinedfilter.md) > [combinator](./search-core.combinedfilter.combinator.md) ## CombinedFilter.combinator property diff --git a/docs/answers-core.combinedfilter.filters.md b/docs/search-core.combinedfilter.filters.md similarity index 55% rename from docs/answers-core.combinedfilter.filters.md rename to docs/search-core.combinedfilter.filters.md index 6fbcddfa..73d97aad 100644 --- a/docs/answers-core.combinedfilter.filters.md +++ b/docs/search-core.combinedfilter.filters.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [CombinedFilter](./answers-core.combinedfilter.md) > [filters](./answers-core.combinedfilter.filters.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [CombinedFilter](./search-core.combinedfilter.md) > [filters](./search-core.combinedfilter.filters.md) ## CombinedFilter.filters property diff --git a/docs/search-core.combinedfilter.md b/docs/search-core.combinedfilter.md new file mode 100644 index 00000000..db5da7cc --- /dev/null +++ b/docs/search-core.combinedfilter.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [CombinedFilter](./search-core.combinedfilter.md) + +## CombinedFilter interface + +Represents multiple filters that will be combined to refine results. + +Signature: + +```typescript +export interface CombinedFilter +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [combinator](./search-core.combinedfilter.combinator.md) | [FilterCombinator](./search-core.filtercombinator.md) | The logical operator used to combine the filters. | +| [filters](./search-core.combinedfilter.filters.md) | ([Filter](./search-core.filter.md) \| [CombinedFilter](./search-core.combinedfilter.md))\[\] | An array of filters applied to the search. | + diff --git a/docs/search-core.context.md b/docs/search-core.context.md new file mode 100644 index 00000000..526795e2 --- /dev/null +++ b/docs/search-core.context.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Context](./search-core.context.md) + +## Context type + +Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). + +Signature: + +```typescript +export declare type Context = any; +``` + +## Remarks + +May be any valid JSON object + diff --git a/docs/answers-core.directanswer.fieldtype.md b/docs/search-core.directanswer.fieldtype.md similarity index 53% rename from docs/answers-core.directanswer.fieldtype.md rename to docs/search-core.directanswer.fieldtype.md index 613e8c7f..09571f86 100644 --- a/docs/answers-core.directanswer.fieldtype.md +++ b/docs/search-core.directanswer.fieldtype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DirectAnswer](./answers-core.directanswer.md) > [fieldType](./answers-core.directanswer.fieldtype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DirectAnswer](./search-core.directanswer.md) > [fieldType](./search-core.directanswer.fieldtype.md) ## DirectAnswer.fieldType property diff --git a/docs/search-core.directanswer.md b/docs/search-core.directanswer.md new file mode 100644 index 00000000..18f1eb25 --- /dev/null +++ b/docs/search-core.directanswer.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DirectAnswer](./search-core.directanswer.md) + +## DirectAnswer interface + +A direct answer to a search. + +Signature: + +```typescript +export interface DirectAnswer +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-core.directanswer.fieldtype.md) | string | The field type of the direct answer. | +| [relatedResult](./search-core.directanswer.relatedresult.md) | [Result](./search-core.result.md) | The entity associated with the direct answer. | +| [type](./search-core.directanswer.type.md) | [DirectAnswerType](./search-core.directanswertype.md) | The [DirectAnswerType](./search-core.directanswertype.md). | +| [value?](./search-core.directanswer.value.md) | string | (Optional) The result of the direct answer. | +| [verticalKey](./search-core.directanswer.verticalkey.md) | string | The vertical key of the direct answer. | + diff --git a/docs/answers-core.directanswer.relatedresult.md b/docs/search-core.directanswer.relatedresult.md similarity index 53% rename from docs/answers-core.directanswer.relatedresult.md rename to docs/search-core.directanswer.relatedresult.md index 7e0d12ea..e0bdce3f 100644 --- a/docs/answers-core.directanswer.relatedresult.md +++ b/docs/search-core.directanswer.relatedresult.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DirectAnswer](./answers-core.directanswer.md) > [relatedResult](./answers-core.directanswer.relatedresult.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DirectAnswer](./search-core.directanswer.md) > [relatedResult](./search-core.directanswer.relatedresult.md) ## DirectAnswer.relatedResult property diff --git a/docs/search-core.directanswer.type.md b/docs/search-core.directanswer.type.md new file mode 100644 index 00000000..e54fc649 --- /dev/null +++ b/docs/search-core.directanswer.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DirectAnswer](./search-core.directanswer.md) > [type](./search-core.directanswer.type.md) + +## DirectAnswer.type property + +The [DirectAnswerType](./search-core.directanswertype.md). + +Signature: + +```typescript +type: DirectAnswerType; +``` diff --git a/docs/search-core.directanswer.value.md b/docs/search-core.directanswer.value.md new file mode 100644 index 00000000..1076e975 --- /dev/null +++ b/docs/search-core.directanswer.value.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DirectAnswer](./search-core.directanswer.md) > [value](./search-core.directanswer.value.md) + +## DirectAnswer.value property + +The result of the direct answer. + +Signature: + +```typescript +value?: string; +``` + +## Remarks + +A value will not be present if the [DirectAnswer.fieldType](./search-core.directanswer.fieldtype.md) is 'rich\_text'. + diff --git a/docs/answers-core.directanswer.verticalkey.md b/docs/search-core.directanswer.verticalkey.md similarity index 53% rename from docs/answers-core.directanswer.verticalkey.md rename to docs/search-core.directanswer.verticalkey.md index 87ac2c69..d7af17f6 100644 --- a/docs/answers-core.directanswer.verticalkey.md +++ b/docs/search-core.directanswer.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DirectAnswer](./answers-core.directanswer.md) > [verticalKey](./answers-core.directanswer.verticalkey.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DirectAnswer](./search-core.directanswer.md) > [verticalKey](./search-core.directanswer.verticalkey.md) ## DirectAnswer.verticalKey property diff --git a/docs/answers-core.directanswertype.md b/docs/search-core.directanswertype.md similarity index 61% rename from docs/answers-core.directanswertype.md rename to docs/search-core.directanswertype.md index 9504bb9d..b8eeb2f6 100644 --- a/docs/answers-core.directanswertype.md +++ b/docs/search-core.directanswertype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DirectAnswerType](./answers-core.directanswertype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DirectAnswerType](./search-core.directanswertype.md) ## DirectAnswerType enum @@ -16,6 +16,6 @@ export declare enum DirectAnswerType | Member | Value | Description | | --- | --- | --- | -| FeaturedSnippet | "FEATURED_SNIPPET" | Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md). | -| FieldValue | "FIELD_VALUE" | Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md). | +| FeaturedSnippet | "FEATURED_SNIPPET" | Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md). | +| FieldValue | "FIELD_VALUE" | Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md). | diff --git a/docs/answers-core.direction.md b/docs/search-core.direction.md similarity index 75% rename from docs/answers-core.direction.md rename to docs/search-core.direction.md index f3dcdad6..2a3bf362 100644 --- a/docs/answers-core.direction.md +++ b/docs/search-core.direction.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Direction](./answers-core.direction.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Direction](./search-core.direction.md) ## Direction enum diff --git a/docs/answers-core.displayablefacet.displayname.md b/docs/search-core.displayablefacet.displayname.md similarity index 55% rename from docs/answers-core.displayablefacet.displayname.md rename to docs/search-core.displayablefacet.displayname.md index f556cf0c..98b6822d 100644 --- a/docs/answers-core.displayablefacet.displayname.md +++ b/docs/search-core.displayablefacet.displayname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DisplayableFacet](./answers-core.displayablefacet.md) > [displayName](./answers-core.displayablefacet.displayname.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DisplayableFacet](./search-core.displayablefacet.md) > [displayName](./search-core.displayablefacet.displayname.md) ## DisplayableFacet.displayName property diff --git a/docs/answers-core.displayablefacet.fieldid.md b/docs/search-core.displayablefacet.fieldid.md similarity index 50% rename from docs/answers-core.displayablefacet.fieldid.md rename to docs/search-core.displayablefacet.fieldid.md index 29d72b3c..000f13a9 100644 --- a/docs/answers-core.displayablefacet.fieldid.md +++ b/docs/search-core.displayablefacet.fieldid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DisplayableFacet](./answers-core.displayablefacet.md) > [fieldId](./answers-core.displayablefacet.fieldid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DisplayableFacet](./search-core.displayablefacet.md) > [fieldId](./search-core.displayablefacet.fieldid.md) ## DisplayableFacet.fieldId property diff --git a/docs/search-core.displayablefacet.md b/docs/search-core.displayablefacet.md new file mode 100644 index 00000000..d093ab92 --- /dev/null +++ b/docs/search-core.displayablefacet.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DisplayableFacet](./search-core.displayablefacet.md) + +## DisplayableFacet interface + +A [Facet](./search-core.facet.md) which contains extra fields meant to be displayed to the end user. + +Signature: + +```typescript +export interface DisplayableFacet extends Facet +``` +Extends: [Facet](./search-core.facet.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [displayName](./search-core.displayablefacet.displayname.md) | string | The name of the facet which is meant to be displayed to the user. | +| [fieldId](./search-core.displayablefacet.fieldid.md) | string | The associated fieldId. | +| [options](./search-core.displayablefacet.options.md) | [DisplayableFacetOption](./search-core.displayablefacetoption.md)\[\] | An array of [DisplayableFacetOption](./search-core.displayablefacetoption.md) | + diff --git a/docs/search-core.displayablefacet.options.md b/docs/search-core.displayablefacet.options.md new file mode 100644 index 00000000..1cfa702f --- /dev/null +++ b/docs/search-core.displayablefacet.options.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DisplayableFacet](./search-core.displayablefacet.md) > [options](./search-core.displayablefacet.options.md) + +## DisplayableFacet.options property + +An array of [DisplayableFacetOption](./search-core.displayablefacetoption.md) + +Signature: + +```typescript +options: DisplayableFacetOption[]; +``` diff --git a/docs/answers-core.displayablefacetoption.count.md b/docs/search-core.displayablefacetoption.count.md similarity index 52% rename from docs/answers-core.displayablefacetoption.count.md rename to docs/search-core.displayablefacetoption.count.md index ff2272c3..8c0b3702 100644 --- a/docs/answers-core.displayablefacetoption.count.md +++ b/docs/search-core.displayablefacetoption.count.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DisplayableFacetOption](./answers-core.displayablefacetoption.md) > [count](./answers-core.displayablefacetoption.count.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DisplayableFacetOption](./search-core.displayablefacetoption.md) > [count](./search-core.displayablefacetoption.count.md) ## DisplayableFacetOption.count property diff --git a/docs/answers-core.displayablefacetoption.displayname.md b/docs/search-core.displayablefacetoption.displayname.md similarity index 54% rename from docs/answers-core.displayablefacetoption.displayname.md rename to docs/search-core.displayablefacetoption.displayname.md index 00441d77..c17d971b 100644 --- a/docs/answers-core.displayablefacetoption.displayname.md +++ b/docs/search-core.displayablefacetoption.displayname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DisplayableFacetOption](./answers-core.displayablefacetoption.md) > [displayName](./answers-core.displayablefacetoption.displayname.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DisplayableFacetOption](./search-core.displayablefacetoption.md) > [displayName](./search-core.displayablefacetoption.displayname.md) ## DisplayableFacetOption.displayName property diff --git a/docs/answers-core.displayablefacetoption.matcher.md b/docs/search-core.displayablefacetoption.matcher.md similarity index 50% rename from docs/answers-core.displayablefacetoption.matcher.md rename to docs/search-core.displayablefacetoption.matcher.md index 20ae7f46..d910e08d 100644 --- a/docs/answers-core.displayablefacetoption.matcher.md +++ b/docs/search-core.displayablefacetoption.matcher.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DisplayableFacetOption](./answers-core.displayablefacetoption.md) > [matcher](./answers-core.displayablefacetoption.matcher.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DisplayableFacetOption](./search-core.displayablefacetoption.md) > [matcher](./search-core.displayablefacetoption.matcher.md) ## DisplayableFacetOption.matcher property diff --git a/docs/search-core.displayablefacetoption.md b/docs/search-core.displayablefacetoption.md new file mode 100644 index 00000000..2d4558c2 --- /dev/null +++ b/docs/search-core.displayablefacetoption.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DisplayableFacetOption](./search-core.displayablefacetoption.md) + +## DisplayableFacetOption interface + +A [FacetOption](./search-core.facetoption.md) with extra data meant to be displayed to the end user. + +Signature: + +```typescript +export interface DisplayableFacetOption extends FacetOption +``` +Extends: [FacetOption](./search-core.facetoption.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [count](./search-core.displayablefacetoption.count.md) | number | The number of results associated with this facet option. | +| [displayName](./search-core.displayablefacetoption.displayname.md) | string | The name of the facet option which is meant to be displayed to the end user. | +| [matcher](./search-core.displayablefacetoption.matcher.md) | [Matcher](./search-core.matcher.md) | A Matcher is a filtering operation. | +| [selected](./search-core.displayablefacetoption.selected.md) | boolean | Whether or not the filter is selected in the search results. | +| [value](./search-core.displayablefacetoption.value.md) | string \| number \| boolean \| [NumberRangeValue](./search-core.numberrangevalue.md) | The value to compare. | + diff --git a/docs/answers-core.displayablefacetoption.selected.md b/docs/search-core.displayablefacetoption.selected.md similarity index 53% rename from docs/answers-core.displayablefacetoption.selected.md rename to docs/search-core.displayablefacetoption.selected.md index 92bc4d1b..e84698f3 100644 --- a/docs/answers-core.displayablefacetoption.selected.md +++ b/docs/search-core.displayablefacetoption.selected.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DisplayableFacetOption](./answers-core.displayablefacetoption.md) > [selected](./answers-core.displayablefacetoption.selected.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DisplayableFacetOption](./search-core.displayablefacetoption.md) > [selected](./search-core.displayablefacetoption.selected.md) ## DisplayableFacetOption.selected property diff --git a/docs/answers-core.displayablefacetoption.value.md b/docs/search-core.displayablefacetoption.value.md similarity index 53% rename from docs/answers-core.displayablefacetoption.value.md rename to docs/search-core.displayablefacetoption.value.md index 120e57cd..383c4736 100644 --- a/docs/answers-core.displayablefacetoption.value.md +++ b/docs/search-core.displayablefacetoption.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [DisplayableFacetOption](./answers-core.displayablefacetoption.md) > [value](./answers-core.displayablefacetoption.value.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [DisplayableFacetOption](./search-core.displayablefacetoption.md) > [value](./search-core.displayablefacetoption.value.md) ## DisplayableFacetOption.value property diff --git a/docs/search-core.endpoints.filtersearch.md b/docs/search-core.endpoints.filtersearch.md new file mode 100644 index 00000000..a544d6b5 --- /dev/null +++ b/docs/search-core.endpoints.filtersearch.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Endpoints](./search-core.endpoints.md) > [filterSearch](./search-core.endpoints.filtersearch.md) + +## Endpoints.filterSearch property + +Signature: + +```typescript +filterSearch?: string; +``` diff --git a/docs/search-core.endpoints.md b/docs/search-core.endpoints.md new file mode 100644 index 00000000..5ddb9d05 --- /dev/null +++ b/docs/search-core.endpoints.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Endpoints](./search-core.endpoints.md) + +## Endpoints interface + +Overrides for the URLs which are used when making requests to the Search API. + +Signature: + +```typescript +export interface Endpoints +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [filterSearch?](./search-core.endpoints.filtersearch.md) | string | (Optional) | +| [questionSubmission?](./search-core.endpoints.questionsubmission.md) | string | (Optional) | +| [status?](./search-core.endpoints.status.md) | string | (Optional) | +| [universalAutocomplete?](./search-core.endpoints.universalautocomplete.md) | string | (Optional) | +| [universalSearch?](./search-core.endpoints.universalsearch.md) | string | (Optional) | +| [verticalAutocomplete?](./search-core.endpoints.verticalautocomplete.md) | string | (Optional) | +| [verticalSearch?](./search-core.endpoints.verticalsearch.md) | string | (Optional) | + diff --git a/docs/search-core.endpoints.questionsubmission.md b/docs/search-core.endpoints.questionsubmission.md new file mode 100644 index 00000000..fff7eaa7 --- /dev/null +++ b/docs/search-core.endpoints.questionsubmission.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Endpoints](./search-core.endpoints.md) > [questionSubmission](./search-core.endpoints.questionsubmission.md) + +## Endpoints.questionSubmission property + +Signature: + +```typescript +questionSubmission?: string; +``` diff --git a/docs/search-core.endpoints.status.md b/docs/search-core.endpoints.status.md new file mode 100644 index 00000000..bae4fe2a --- /dev/null +++ b/docs/search-core.endpoints.status.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Endpoints](./search-core.endpoints.md) > [status](./search-core.endpoints.status.md) + +## Endpoints.status property + +Signature: + +```typescript +status?: string; +``` diff --git a/docs/search-core.endpoints.universalautocomplete.md b/docs/search-core.endpoints.universalautocomplete.md new file mode 100644 index 00000000..a35cd629 --- /dev/null +++ b/docs/search-core.endpoints.universalautocomplete.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Endpoints](./search-core.endpoints.md) > [universalAutocomplete](./search-core.endpoints.universalautocomplete.md) + +## Endpoints.universalAutocomplete property + +Signature: + +```typescript +universalAutocomplete?: string; +``` diff --git a/docs/search-core.endpoints.universalsearch.md b/docs/search-core.endpoints.universalsearch.md new file mode 100644 index 00000000..8f4e49a4 --- /dev/null +++ b/docs/search-core.endpoints.universalsearch.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Endpoints](./search-core.endpoints.md) > [universalSearch](./search-core.endpoints.universalsearch.md) + +## Endpoints.universalSearch property + +Signature: + +```typescript +universalSearch?: string; +``` diff --git a/docs/search-core.endpoints.verticalautocomplete.md b/docs/search-core.endpoints.verticalautocomplete.md new file mode 100644 index 00000000..f3d09749 --- /dev/null +++ b/docs/search-core.endpoints.verticalautocomplete.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Endpoints](./search-core.endpoints.md) > [verticalAutocomplete](./search-core.endpoints.verticalautocomplete.md) + +## Endpoints.verticalAutocomplete property + +Signature: + +```typescript +verticalAutocomplete?: string; +``` diff --git a/docs/search-core.endpoints.verticalsearch.md b/docs/search-core.endpoints.verticalsearch.md new file mode 100644 index 00000000..18919693 --- /dev/null +++ b/docs/search-core.endpoints.verticalsearch.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Endpoints](./search-core.endpoints.md) > [verticalSearch](./search-core.endpoints.verticalsearch.md) + +## Endpoints.verticalSearch property + +Signature: + +```typescript +verticalSearch?: string; +``` diff --git a/docs/answers-core.errortype.md b/docs/search-core.errortype.md similarity index 83% rename from docs/answers-core.errortype.md rename to docs/search-core.errortype.md index 9e5b779a..c35ff7d0 100644 --- a/docs/answers-core.errortype.md +++ b/docs/search-core.errortype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [ErrorType](./answers-core.errortype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [ErrorType](./search-core.errortype.md) ## ErrorType enum diff --git a/docs/answers-core.facet.fieldid.md b/docs/search-core.facet.fieldid.md similarity index 53% rename from docs/answers-core.facet.fieldid.md rename to docs/search-core.facet.fieldid.md index 4f03a68f..8777193c 100644 --- a/docs/answers-core.facet.fieldid.md +++ b/docs/search-core.facet.fieldid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Facet](./answers-core.facet.md) > [fieldId](./answers-core.facet.fieldid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Facet](./search-core.facet.md) > [fieldId](./search-core.facet.fieldid.md) ## Facet.fieldId property diff --git a/docs/search-core.facet.md b/docs/search-core.facet.md new file mode 100644 index 00000000..e4b10703 --- /dev/null +++ b/docs/search-core.facet.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Facet](./search-core.facet.md) + +## Facet interface + +Represents dynamic filter options for the Search API. + +Signature: + +```typescript +export interface Facet +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldId](./search-core.facet.fieldid.md) | string | The associated fieldId. | +| [options](./search-core.facet.options.md) | [FacetOption](./search-core.facetoption.md)\[\] | An array of [FacetOption](./search-core.facetoption.md) | + diff --git a/docs/answers-core.facet.options.md b/docs/search-core.facet.options.md similarity index 52% rename from docs/answers-core.facet.options.md rename to docs/search-core.facet.options.md index 76107afa..0c659368 100644 --- a/docs/answers-core.facet.options.md +++ b/docs/search-core.facet.options.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Facet](./answers-core.facet.md) > [options](./answers-core.facet.options.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Facet](./search-core.facet.md) > [options](./search-core.facet.options.md) ## Facet.options property -An array of [FacetOption](./answers-core.facetoption.md) +An array of [FacetOption](./search-core.facetoption.md) Signature: diff --git a/docs/answers-core.facetoption.matcher.md b/docs/search-core.facetoption.matcher.md similarity index 53% rename from docs/answers-core.facetoption.matcher.md rename to docs/search-core.facetoption.matcher.md index 3325a0ed..202080d0 100644 --- a/docs/answers-core.facetoption.matcher.md +++ b/docs/search-core.facetoption.matcher.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FacetOption](./answers-core.facetoption.md) > [matcher](./answers-core.facetoption.matcher.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FacetOption](./search-core.facetoption.md) > [matcher](./search-core.facetoption.matcher.md) ## FacetOption.matcher property diff --git a/docs/search-core.facetoption.md b/docs/search-core.facetoption.md new file mode 100644 index 00000000..42c429b6 --- /dev/null +++ b/docs/search-core.facetoption.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FacetOption](./search-core.facetoption.md) + +## FacetOption interface + +A filter associated with the facet. + +Signature: + +```typescript +export interface FacetOption +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [matcher](./search-core.facetoption.matcher.md) | [Matcher](./search-core.matcher.md) | A Matcher is a filtering operation. | +| [value](./search-core.facetoption.value.md) | string \| number \| boolean \| [NumberRangeValue](./search-core.numberrangevalue.md) | The value to compare. | + diff --git a/docs/answers-core.facetoption.value.md b/docs/search-core.facetoption.value.md similarity index 57% rename from docs/answers-core.facetoption.value.md rename to docs/search-core.facetoption.value.md index f8fbf44e..7b5d5e2a 100644 --- a/docs/answers-core.facetoption.value.md +++ b/docs/search-core.facetoption.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FacetOption](./answers-core.facetoption.md) > [value](./answers-core.facetoption.value.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FacetOption](./search-core.facetoption.md) > [value](./search-core.facetoption.value.md) ## FacetOption.value property diff --git a/docs/answers-core.failedvertical.details.md b/docs/search-core.failedvertical.details.md similarity index 58% rename from docs/answers-core.failedvertical.details.md rename to docs/search-core.failedvertical.details.md index 8b6fd312..ee0be59e 100644 --- a/docs/answers-core.failedvertical.details.md +++ b/docs/search-core.failedvertical.details.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FailedVertical](./answers-core.failedvertical.md) > [details](./answers-core.failedvertical.details.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FailedVertical](./search-core.failedvertical.md) > [details](./search-core.failedvertical.details.md) ## FailedVertical.details property diff --git a/docs/answers-core.failedvertical.errortype.md b/docs/search-core.failedvertical.errortype.md similarity index 54% rename from docs/answers-core.failedvertical.errortype.md rename to docs/search-core.failedvertical.errortype.md index 843325dd..3486acf2 100644 --- a/docs/answers-core.failedvertical.errortype.md +++ b/docs/search-core.failedvertical.errortype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FailedVertical](./answers-core.failedvertical.md) > [errorType](./answers-core.failedvertical.errortype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FailedVertical](./search-core.failedvertical.md) > [errorType](./search-core.failedvertical.errortype.md) ## FailedVertical.errorType property diff --git a/docs/search-core.failedvertical.md b/docs/search-core.failedvertical.md new file mode 100644 index 00000000..cfd88b01 --- /dev/null +++ b/docs/search-core.failedvertical.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FailedVertical](./search-core.failedvertical.md) + +## FailedVertical interface + +Error information from when a vertical fails to return results. + +Signature: + +```typescript +export interface FailedVertical +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [details](./search-core.failedvertical.details.md) | { responseCode: number; description: string; } | Detailed information about the error. | +| [errorType](./search-core.failedvertical.errortype.md) | [ErrorType](./search-core.errortype.md) | Identifier for the type of error causing the failure. | +| [queryDurationMillis](./search-core.failedvertical.querydurationmillis.md) | number | The duration of the query in milliseconds. | +| [verticalKey](./search-core.failedvertical.verticalkey.md) | string | The vertical key associated with the failed vertical. | + diff --git a/docs/answers-core.failedvertical.querydurationmillis.md b/docs/search-core.failedvertical.querydurationmillis.md similarity index 52% rename from docs/answers-core.failedvertical.querydurationmillis.md rename to docs/search-core.failedvertical.querydurationmillis.md index 10390870..da53dfb6 100644 --- a/docs/answers-core.failedvertical.querydurationmillis.md +++ b/docs/search-core.failedvertical.querydurationmillis.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FailedVertical](./answers-core.failedvertical.md) > [queryDurationMillis](./answers-core.failedvertical.querydurationmillis.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FailedVertical](./search-core.failedvertical.md) > [queryDurationMillis](./search-core.failedvertical.querydurationmillis.md) ## FailedVertical.queryDurationMillis property diff --git a/docs/answers-core.failedvertical.verticalkey.md b/docs/search-core.failedvertical.verticalkey.md similarity index 54% rename from docs/answers-core.failedvertical.verticalkey.md rename to docs/search-core.failedvertical.verticalkey.md index 3dbbfa41..3d6b4a1c 100644 --- a/docs/answers-core.failedvertical.verticalkey.md +++ b/docs/search-core.failedvertical.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FailedVertical](./answers-core.failedvertical.md) > [verticalKey](./answers-core.failedvertical.verticalkey.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FailedVertical](./search-core.failedvertical.md) > [verticalKey](./search-core.failedvertical.verticalkey.md) ## FailedVertical.verticalKey property diff --git a/docs/search-core.featuredsnippetdirectanswer.fieldtype.md b/docs/search-core.featuredsnippetdirectanswer.fieldtype.md new file mode 100644 index 00000000..1a5e64a0 --- /dev/null +++ b/docs/search-core.featuredsnippetdirectanswer.fieldtype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) > [fieldType](./search-core.featuredsnippetdirectanswer.fieldtype.md) + +## FeaturedSnippetDirectAnswer.fieldType property + +The field type of the direct answer. + +Signature: + +```typescript +fieldType: string; +``` diff --git a/docs/search-core.featuredsnippetdirectanswer.md b/docs/search-core.featuredsnippetdirectanswer.md new file mode 100644 index 00000000..a8c535d4 --- /dev/null +++ b/docs/search-core.featuredsnippetdirectanswer.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) + +## FeaturedSnippetDirectAnswer interface + +A direct answer which was found within a document. + +Signature: + +```typescript +export interface FeaturedSnippetDirectAnswer extends DirectAnswer +``` +Extends: [DirectAnswer](./search-core.directanswer.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-core.featuredsnippetdirectanswer.fieldtype.md) | string | The field type of the direct answer. | +| [relatedResult](./search-core.featuredsnippetdirectanswer.relatedresult.md) | [Result](./search-core.result.md) | The entity associated with the direct answer. | +| [snippet](./search-core.featuredsnippetdirectanswer.snippet.md) | [Snippet](./search-core.snippet.md) | The snippet where the direct answer was found. | +| [type](./search-core.featuredsnippetdirectanswer.type.md) | [DirectAnswerType.FeaturedSnippet](./search-core.directanswertype.md) | [DirectAnswerType](./search-core.directanswertype.md).FeaturedSnippet. | +| [value?](./search-core.featuredsnippetdirectanswer.value.md) | string | (Optional) The result of the direct answer. | +| [verticalKey](./search-core.featuredsnippetdirectanswer.verticalkey.md) | string | The vertical key of the direct answer. | + diff --git a/docs/answers-core.featuredsnippetdirectanswer.relatedresult.md b/docs/search-core.featuredsnippetdirectanswer.relatedresult.md similarity index 50% rename from docs/answers-core.featuredsnippetdirectanswer.relatedresult.md rename to docs/search-core.featuredsnippetdirectanswer.relatedresult.md index edc7ad32..b4225916 100644 --- a/docs/answers-core.featuredsnippetdirectanswer.relatedresult.md +++ b/docs/search-core.featuredsnippetdirectanswer.relatedresult.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) > [relatedResult](./answers-core.featuredsnippetdirectanswer.relatedresult.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) > [relatedResult](./search-core.featuredsnippetdirectanswer.relatedresult.md) ## FeaturedSnippetDirectAnswer.relatedResult property diff --git a/docs/answers-core.featuredsnippetdirectanswer.snippet.md b/docs/search-core.featuredsnippetdirectanswer.snippet.md similarity index 50% rename from docs/answers-core.featuredsnippetdirectanswer.snippet.md rename to docs/search-core.featuredsnippetdirectanswer.snippet.md index 3d9f2bdb..b85ac80f 100644 --- a/docs/answers-core.featuredsnippetdirectanswer.snippet.md +++ b/docs/search-core.featuredsnippetdirectanswer.snippet.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) > [snippet](./answers-core.featuredsnippetdirectanswer.snippet.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) > [snippet](./search-core.featuredsnippetdirectanswer.snippet.md) ## FeaturedSnippetDirectAnswer.snippet property diff --git a/docs/search-core.featuredsnippetdirectanswer.type.md b/docs/search-core.featuredsnippetdirectanswer.type.md new file mode 100644 index 00000000..e5428ab2 --- /dev/null +++ b/docs/search-core.featuredsnippetdirectanswer.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) > [type](./search-core.featuredsnippetdirectanswer.type.md) + +## FeaturedSnippetDirectAnswer.type property + +[DirectAnswerType](./search-core.directanswertype.md).FeaturedSnippet. + +Signature: + +```typescript +type: DirectAnswerType.FeaturedSnippet; +``` diff --git a/docs/search-core.featuredsnippetdirectanswer.value.md b/docs/search-core.featuredsnippetdirectanswer.value.md new file mode 100644 index 00000000..2627ae03 --- /dev/null +++ b/docs/search-core.featuredsnippetdirectanswer.value.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) > [value](./search-core.featuredsnippetdirectanswer.value.md) + +## FeaturedSnippetDirectAnswer.value property + +The result of the direct answer. + +Signature: + +```typescript +value?: string; +``` + +## Remarks + +A value will not be present if the [DirectAnswer.fieldType](./search-core.directanswer.fieldtype.md) is 'rich\_text'. + diff --git a/docs/search-core.featuredsnippetdirectanswer.verticalkey.md b/docs/search-core.featuredsnippetdirectanswer.verticalkey.md new file mode 100644 index 00000000..c7e00c0c --- /dev/null +++ b/docs/search-core.featuredsnippetdirectanswer.verticalkey.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) > [verticalKey](./search-core.featuredsnippetdirectanswer.verticalkey.md) + +## FeaturedSnippetDirectAnswer.verticalKey property + +The vertical key of the direct answer. + +Signature: + +```typescript +verticalKey: string; +``` diff --git a/docs/answers-core.fieldvaluedirectanswer.entityname.md b/docs/search-core.fieldvaluedirectanswer.entityname.md similarity index 52% rename from docs/answers-core.fieldvaluedirectanswer.entityname.md rename to docs/search-core.fieldvaluedirectanswer.entityname.md index a77201ca..7cd22617 100644 --- a/docs/answers-core.fieldvaluedirectanswer.entityname.md +++ b/docs/search-core.fieldvaluedirectanswer.entityname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) > [entityName](./answers-core.fieldvaluedirectanswer.entityname.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) > [entityName](./search-core.fieldvaluedirectanswer.entityname.md) ## FieldValueDirectAnswer.entityName property diff --git a/docs/answers-core.fieldvaluedirectanswer.fieldapiname.md b/docs/search-core.fieldvaluedirectanswer.fieldapiname.md similarity index 50% rename from docs/answers-core.fieldvaluedirectanswer.fieldapiname.md rename to docs/search-core.fieldvaluedirectanswer.fieldapiname.md index 9f5b3386..f6827355 100644 --- a/docs/answers-core.fieldvaluedirectanswer.fieldapiname.md +++ b/docs/search-core.fieldvaluedirectanswer.fieldapiname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) > [fieldApiName](./answers-core.fieldvaluedirectanswer.fieldapiname.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) > [fieldApiName](./search-core.fieldvaluedirectanswer.fieldapiname.md) ## FieldValueDirectAnswer.fieldApiName property diff --git a/docs/answers-core.fieldvaluedirectanswer.fieldname.md b/docs/search-core.fieldvaluedirectanswer.fieldname.md similarity index 50% rename from docs/answers-core.fieldvaluedirectanswer.fieldname.md rename to docs/search-core.fieldvaluedirectanswer.fieldname.md index b7e7573d..fd8b6cff 100644 --- a/docs/answers-core.fieldvaluedirectanswer.fieldname.md +++ b/docs/search-core.fieldvaluedirectanswer.fieldname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) > [fieldName](./answers-core.fieldvaluedirectanswer.fieldname.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) > [fieldName](./search-core.fieldvaluedirectanswer.fieldname.md) ## FieldValueDirectAnswer.fieldName property diff --git a/docs/answers-core.fieldvaluedirectanswer.fieldtype.md b/docs/search-core.fieldvaluedirectanswer.fieldtype.md similarity index 50% rename from docs/answers-core.fieldvaluedirectanswer.fieldtype.md rename to docs/search-core.fieldvaluedirectanswer.fieldtype.md index 1a0ab61d..e7af3c09 100644 --- a/docs/answers-core.fieldvaluedirectanswer.fieldtype.md +++ b/docs/search-core.fieldvaluedirectanswer.fieldtype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) > [fieldType](./answers-core.fieldvaluedirectanswer.fieldtype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) > [fieldType](./search-core.fieldvaluedirectanswer.fieldtype.md) ## FieldValueDirectAnswer.fieldType property diff --git a/docs/search-core.fieldvaluedirectanswer.md b/docs/search-core.fieldvaluedirectanswer.md new file mode 100644 index 00000000..1bc85324 --- /dev/null +++ b/docs/search-core.fieldvaluedirectanswer.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) + +## FieldValueDirectAnswer interface + +A direct answer where the answer came from a field from the knowledge graph. + +Signature: + +```typescript +export interface FieldValueDirectAnswer extends DirectAnswer +``` +Extends: [DirectAnswer](./search-core.directanswer.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [entityName](./search-core.fieldvaluedirectanswer.entityname.md) | string | The name of the entity that direct answer came from. | +| [fieldApiName](./search-core.fieldvaluedirectanswer.fieldapiname.md) | string | The field api name of the direct answer. | +| [fieldName](./search-core.fieldvaluedirectanswer.fieldname.md) | string | The field name of the direct answer. | +| [fieldType](./search-core.fieldvaluedirectanswer.fieldtype.md) | string | The field type of the direct answer. | +| [relatedResult](./search-core.fieldvaluedirectanswer.relatedresult.md) | [Result](./search-core.result.md) | The entity associated with the direct answer. | +| [type](./search-core.fieldvaluedirectanswer.type.md) | [DirectAnswerType.FieldValue](./search-core.directanswertype.md) | [DirectAnswerType](./search-core.directanswertype.md).FieldValue. | +| [value](./search-core.fieldvaluedirectanswer.value.md) | string | The result of the direct answer. | +| [verticalKey](./search-core.fieldvaluedirectanswer.verticalkey.md) | string | The vertical key of the direct answer. | + diff --git a/docs/answers-core.fieldvaluedirectanswer.relatedresult.md b/docs/search-core.fieldvaluedirectanswer.relatedresult.md similarity index 51% rename from docs/answers-core.fieldvaluedirectanswer.relatedresult.md rename to docs/search-core.fieldvaluedirectanswer.relatedresult.md index 09b0f8b9..fe294b19 100644 --- a/docs/answers-core.fieldvaluedirectanswer.relatedresult.md +++ b/docs/search-core.fieldvaluedirectanswer.relatedresult.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) > [relatedResult](./answers-core.fieldvaluedirectanswer.relatedresult.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) > [relatedResult](./search-core.fieldvaluedirectanswer.relatedresult.md) ## FieldValueDirectAnswer.relatedResult property diff --git a/docs/search-core.fieldvaluedirectanswer.type.md b/docs/search-core.fieldvaluedirectanswer.type.md new file mode 100644 index 00000000..83b42814 --- /dev/null +++ b/docs/search-core.fieldvaluedirectanswer.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) > [type](./search-core.fieldvaluedirectanswer.type.md) + +## FieldValueDirectAnswer.type property + +[DirectAnswerType](./search-core.directanswertype.md).FieldValue. + +Signature: + +```typescript +type: DirectAnswerType.FieldValue; +``` diff --git a/docs/search-core.fieldvaluedirectanswer.value.md b/docs/search-core.fieldvaluedirectanswer.value.md new file mode 100644 index 00000000..aa85b209 --- /dev/null +++ b/docs/search-core.fieldvaluedirectanswer.value.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) > [value](./search-core.fieldvaluedirectanswer.value.md) + +## FieldValueDirectAnswer.value property + +The result of the direct answer. + +Signature: + +```typescript +value: string; +``` + +## Remarks + +A value will not be present if the [DirectAnswer.fieldType](./search-core.directanswer.fieldtype.md) is 'rich\_text'. + diff --git a/docs/answers-core.fieldvaluedirectanswer.verticalkey.md b/docs/search-core.fieldvaluedirectanswer.verticalkey.md similarity index 50% rename from docs/answers-core.fieldvaluedirectanswer.verticalkey.md rename to docs/search-core.fieldvaluedirectanswer.verticalkey.md index 44fdeddc..5f9197cc 100644 --- a/docs/answers-core.fieldvaluedirectanswer.verticalkey.md +++ b/docs/search-core.fieldvaluedirectanswer.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) > [verticalKey](./answers-core.fieldvaluedirectanswer.verticalkey.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) > [verticalKey](./search-core.fieldvaluedirectanswer.verticalkey.md) ## FieldValueDirectAnswer.verticalKey property diff --git a/docs/answers-core.filter.fieldid.md b/docs/search-core.filter.fieldid.md similarity index 58% rename from docs/answers-core.filter.fieldid.md rename to docs/search-core.filter.fieldid.md index 55327737..9c2ca524 100644 --- a/docs/answers-core.filter.fieldid.md +++ b/docs/search-core.filter.fieldid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Filter](./answers-core.filter.md) > [fieldId](./answers-core.filter.fieldid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Filter](./search-core.filter.md) > [fieldId](./search-core.filter.fieldid.md) ## Filter.fieldId property diff --git a/docs/answers-core.filter.matcher.md b/docs/search-core.filter.matcher.md similarity index 55% rename from docs/answers-core.filter.matcher.md rename to docs/search-core.filter.matcher.md index c737b94e..41197f93 100644 --- a/docs/answers-core.filter.matcher.md +++ b/docs/search-core.filter.matcher.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Filter](./answers-core.filter.md) > [matcher](./answers-core.filter.matcher.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Filter](./search-core.filter.md) > [matcher](./search-core.filter.matcher.md) ## Filter.matcher property diff --git a/docs/search-core.filter.md b/docs/search-core.filter.md new file mode 100644 index 00000000..4851d627 --- /dev/null +++ b/docs/search-core.filter.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Filter](./search-core.filter.md) + +## Filter interface + +Represents a filter which compares values to a single field. + +Signature: + +```typescript +export interface Filter +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldId](./search-core.filter.fieldid.md) | string | The fieldId to apply the filter against. | +| [matcher](./search-core.filter.matcher.md) | [Matcher](./search-core.matcher.md) | A Matcher is a filtering operation. | +| [value](./search-core.filter.value.md) | string \| number \| boolean \| [NearFilterValue](./search-core.nearfiltervalue.md) \| [NumberRangeValue](./search-core.numberrangevalue.md) | The value to compare. | + diff --git a/docs/answers-core.filter.value.md b/docs/search-core.filter.value.md similarity index 61% rename from docs/answers-core.filter.value.md rename to docs/search-core.filter.value.md index 8fb9fb5d..a552358c 100644 --- a/docs/answers-core.filter.value.md +++ b/docs/search-core.filter.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Filter](./answers-core.filter.md) > [value](./answers-core.filter.value.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Filter](./search-core.filter.md) > [value](./search-core.filter.value.md) ## Filter.value property diff --git a/docs/answers-core.filtercombinator.md b/docs/search-core.filtercombinator.md similarity index 65% rename from docs/answers-core.filtercombinator.md rename to docs/search-core.filtercombinator.md index 3ef72d72..7c2789e5 100644 --- a/docs/answers-core.filtercombinator.md +++ b/docs/search-core.filtercombinator.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterCombinator](./answers-core.filtercombinator.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterCombinator](./search-core.filtercombinator.md) ## FilterCombinator enum -Indicates how the filters in a [CombinedFilter](./answers-core.combinedfilter.md) should be combined. +Indicates how the filters in a [CombinedFilter](./search-core.combinedfilter.md) should be combined. Signature: diff --git a/docs/answers-core.filtersearchrequest.excluded.md b/docs/search-core.filtersearchrequest.excluded.md similarity index 55% rename from docs/answers-core.filtersearchrequest.excluded.md rename to docs/search-core.filtersearchrequest.excluded.md index e11a2b79..621b3d3d 100644 --- a/docs/answers-core.filtersearchrequest.excluded.md +++ b/docs/search-core.filtersearchrequest.excluded.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchRequest](./answers-core.filtersearchrequest.md) > [excluded](./answers-core.filtersearchrequest.excluded.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchRequest](./search-core.filtersearchrequest.md) > [excluded](./search-core.filtersearchrequest.excluded.md) ## FilterSearchRequest.excluded property diff --git a/docs/search-core.filtersearchrequest.fields.md b/docs/search-core.filtersearchrequest.fields.md new file mode 100644 index 00000000..98fe1a1f --- /dev/null +++ b/docs/search-core.filtersearchrequest.fields.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchRequest](./search-core.filtersearchrequest.md) > [fields](./search-core.filtersearchrequest.fields.md) + +## FilterSearchRequest.fields property + +An array of [SearchParameterField](./search-core.searchparameterfield.md) + +Signature: + +```typescript +fields: SearchParameterField[]; +``` diff --git a/docs/answers-core.filtersearchrequest.input.md b/docs/search-core.filtersearchrequest.input.md similarity index 51% rename from docs/answers-core.filtersearchrequest.input.md rename to docs/search-core.filtersearchrequest.input.md index a78b8062..adc41bf1 100644 --- a/docs/answers-core.filtersearchrequest.input.md +++ b/docs/search-core.filtersearchrequest.input.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchRequest](./answers-core.filtersearchrequest.md) > [input](./answers-core.filtersearchrequest.input.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchRequest](./search-core.filtersearchrequest.md) > [input](./search-core.filtersearchrequest.input.md) ## FilterSearchRequest.input property diff --git a/docs/search-core.filtersearchrequest.md b/docs/search-core.filtersearchrequest.md new file mode 100644 index 00000000..266caf5c --- /dev/null +++ b/docs/search-core.filtersearchrequest.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchRequest](./search-core.filtersearchrequest.md) + +## FilterSearchRequest interface + +Options for a filtersearch request. + +Signature: + +```typescript +export interface FilterSearchRequest extends SearchRequest +``` +Extends: [SearchRequest](./search-core.searchrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [excluded?](./search-core.filtersearchrequest.excluded.md) | [Filter](./search-core.filter.md)\[\] | (Optional) an array of filters that should be excluded from filter search results. | +| [fields](./search-core.filtersearchrequest.fields.md) | [SearchParameterField](./search-core.searchparameterfield.md)\[\] | An array of [SearchParameterField](./search-core.searchparameterfield.md) | +| [input](./search-core.filtersearchrequest.input.md) | string | The input string for autocomplete. | +| [sectioned](./search-core.filtersearchrequest.sectioned.md) | boolean | Determines whether or not the results of the [FilterSearchResponse](./search-core.filtersearchresponse.md) are separated by field. | +| [sessionTrackingEnabled?](./search-core.filtersearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | +| [verticalKey](./search-core.filtersearchrequest.verticalkey.md) | string | The key for the vertical to get autocomplete suggestions from. | + diff --git a/docs/search-core.filtersearchrequest.sectioned.md b/docs/search-core.filtersearchrequest.sectioned.md new file mode 100644 index 00000000..476c9aed --- /dev/null +++ b/docs/search-core.filtersearchrequest.sectioned.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchRequest](./search-core.filtersearchrequest.md) > [sectioned](./search-core.filtersearchrequest.sectioned.md) + +## FilterSearchRequest.sectioned property + +Determines whether or not the results of the [FilterSearchResponse](./search-core.filtersearchresponse.md) are separated by field. + +Signature: + +```typescript +sectioned: boolean; +``` diff --git a/docs/answers-core.filtersearchrequest.sessiontrackingenabled.md b/docs/search-core.filtersearchrequest.sessiontrackingenabled.md similarity index 50% rename from docs/answers-core.filtersearchrequest.sessiontrackingenabled.md rename to docs/search-core.filtersearchrequest.sessiontrackingenabled.md index 1e28f07b..ae8023c0 100644 --- a/docs/answers-core.filtersearchrequest.sessiontrackingenabled.md +++ b/docs/search-core.filtersearchrequest.sessiontrackingenabled.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchRequest](./answers-core.filtersearchrequest.md) > [sessionTrackingEnabled](./answers-core.filtersearchrequest.sessiontrackingenabled.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchRequest](./search-core.filtersearchrequest.md) > [sessionTrackingEnabled](./search-core.filtersearchrequest.sessiontrackingenabled.md) ## FilterSearchRequest.sessionTrackingEnabled property diff --git a/docs/answers-core.filtersearchrequest.verticalkey.md b/docs/search-core.filtersearchrequest.verticalkey.md similarity index 53% rename from docs/answers-core.filtersearchrequest.verticalkey.md rename to docs/search-core.filtersearchrequest.verticalkey.md index 0ca22bfd..020421ea 100644 --- a/docs/answers-core.filtersearchrequest.verticalkey.md +++ b/docs/search-core.filtersearchrequest.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchRequest](./answers-core.filtersearchrequest.md) > [verticalKey](./answers-core.filtersearchrequest.verticalkey.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchRequest](./search-core.filtersearchrequest.md) > [verticalKey](./search-core.filtersearchrequest.verticalkey.md) ## FilterSearchRequest.verticalKey property diff --git a/docs/search-core.filtersearchresponse.businessid.md b/docs/search-core.filtersearchresponse.businessid.md new file mode 100644 index 00000000..34259795 --- /dev/null +++ b/docs/search-core.filtersearchresponse.businessid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchResponse](./search-core.filtersearchresponse.md) > [businessId](./search-core.filtersearchresponse.businessid.md) + +## FilterSearchResponse.businessId property + +ID of the account associated with this Search experience. + +Signature: + +```typescript +businessId?: string; +``` diff --git a/docs/search-core.filtersearchresponse.md b/docs/search-core.filtersearchresponse.md new file mode 100644 index 00000000..623e8623 --- /dev/null +++ b/docs/search-core.filtersearchresponse.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchResponse](./search-core.filtersearchresponse.md) + +## FilterSearchResponse interface + +The response of a filtersearch request. + +Signature: + +```typescript +export interface FilterSearchResponse +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [businessId?](./search-core.filtersearchresponse.businessid.md) | string | (Optional) ID of the account associated with this Search experience. | +| [queryId?](./search-core.filtersearchresponse.queryid.md) | string | (Optional) The ID of the search query. | +| [sections](./search-core.filtersearchresponse.sections.md) | { label?: string; results: [AutocompleteResult](./search-core.autocompleteresult.md)\[\]; }\[\] | Represents autocomplete results separated by field. | +| [uuid](./search-core.filtersearchresponse.uuid.md) | string | A unique id which corresponds to the request. | + diff --git a/docs/answers-core.filtersearchresponse.queryid.md b/docs/search-core.filtersearchresponse.queryid.md similarity index 50% rename from docs/answers-core.filtersearchresponse.queryid.md rename to docs/search-core.filtersearchresponse.queryid.md index dd679f69..cdb83bdc 100644 --- a/docs/answers-core.filtersearchresponse.queryid.md +++ b/docs/search-core.filtersearchresponse.queryid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchResponse](./answers-core.filtersearchresponse.md) > [queryId](./answers-core.filtersearchresponse.queryid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchResponse](./search-core.filtersearchresponse.md) > [queryId](./search-core.filtersearchresponse.queryid.md) ## FilterSearchResponse.queryId property diff --git a/docs/answers-core.filtersearchresponse.sections.md b/docs/search-core.filtersearchresponse.sections.md similarity index 67% rename from docs/answers-core.filtersearchresponse.sections.md rename to docs/search-core.filtersearchresponse.sections.md index 988db5ae..c7568811 100644 --- a/docs/answers-core.filtersearchresponse.sections.md +++ b/docs/search-core.filtersearchresponse.sections.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchResponse](./answers-core.filtersearchresponse.md) > [sections](./answers-core.filtersearchresponse.sections.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchResponse](./search-core.filtersearchresponse.md) > [sections](./search-core.filtersearchresponse.sections.md) ## FilterSearchResponse.sections property diff --git a/docs/answers-core.filtersearchresponse.uuid.md b/docs/search-core.filtersearchresponse.uuid.md similarity index 52% rename from docs/answers-core.filtersearchresponse.uuid.md rename to docs/search-core.filtersearchresponse.uuid.md index 91cc6449..2f01d6ae 100644 --- a/docs/answers-core.filtersearchresponse.uuid.md +++ b/docs/search-core.filtersearchresponse.uuid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [FilterSearchResponse](./answers-core.filtersearchresponse.md) > [uuid](./answers-core.filtersearchresponse.uuid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [FilterSearchResponse](./search-core.filtersearchresponse.md) > [uuid](./search-core.filtersearchresponse.uuid.md) ## FilterSearchResponse.uuid property diff --git a/docs/answers-core.highlightedfields.md b/docs/search-core.highlightedfields.md similarity index 64% rename from docs/answers-core.highlightedfields.md rename to docs/search-core.highlightedfields.md index ecc15856..a78aa79f 100644 --- a/docs/answers-core.highlightedfields.md +++ b/docs/search-core.highlightedfields.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [HighlightedFields](./answers-core.highlightedfields.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [HighlightedFields](./search-core.highlightedfields.md) ## HighlightedFields type -A mapping of fields to the values emphasized by the Answers API +A mapping of fields to the values emphasized by the Search API. Signature: @@ -13,11 +13,11 @@ export declare type HighlightedFields = { [fieldId: string]: HighlightedValue | HighlightedValue[] | HighlightedFields | HighlightedFields[]; }; ``` -References: [HighlightedValue](./answers-core.highlightedvalue.md), [HighlightedFields](./answers-core.highlightedfields.md) +References: [HighlightedValue](./search-core.highlightedvalue.md), [HighlightedFields](./search-core.highlightedfields.md) ## Remarks -Only fields that have been marked as highlighted will be present - which may not be all fields of the corresponding [Result](./answers-core.result.md)'s rawData. Fields that are present will match the rawData's structure and order. +Only fields that have been marked as highlighted will be present - which may not be all fields of the corresponding [Result](./search-core.result.md)'s rawData. Fields that are present will match the rawData's structure and order. ## Example diff --git a/docs/answers-core.highlightedvalue.matchedsubstrings.md b/docs/search-core.highlightedvalue.matchedsubstrings.md similarity index 74% rename from docs/answers-core.highlightedvalue.matchedsubstrings.md rename to docs/search-core.highlightedvalue.matchedsubstrings.md index e7cb17b1..d9a51d21 100644 --- a/docs/answers-core.highlightedvalue.matchedsubstrings.md +++ b/docs/search-core.highlightedvalue.matchedsubstrings.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [HighlightedValue](./answers-core.highlightedvalue.md) > [matchedSubstrings](./answers-core.highlightedvalue.matchedsubstrings.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [HighlightedValue](./search-core.highlightedvalue.md) > [matchedSubstrings](./search-core.highlightedvalue.matchedsubstrings.md) ## HighlightedValue.matchedSubstrings property diff --git a/docs/search-core.highlightedvalue.md b/docs/search-core.highlightedvalue.md new file mode 100644 index 00000000..4ad31e60 --- /dev/null +++ b/docs/search-core.highlightedvalue.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [HighlightedValue](./search-core.highlightedvalue.md) + +## HighlightedValue interface + +A field value and its substring matches as emphasized by the Search API. + +Signature: + +```typescript +export interface HighlightedValue +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [matchedSubstrings](./search-core.highlightedvalue.matchedsubstrings.md) | { length: number; offset: number; }\[\] | An array of substring matches which correspond to the highlighting. | +| [value](./search-core.highlightedvalue.value.md) | string | The value of the field which should be highlighted. | + diff --git a/docs/answers-core.highlightedvalue.value.md b/docs/search-core.highlightedvalue.value.md similarity index 54% rename from docs/answers-core.highlightedvalue.value.md rename to docs/search-core.highlightedvalue.value.md index f8ed5530..debb1eed 100644 --- a/docs/answers-core.highlightedvalue.value.md +++ b/docs/search-core.highlightedvalue.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [HighlightedValue](./answers-core.highlightedvalue.md) > [value](./answers-core.highlightedvalue.value.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [HighlightedValue](./search-core.highlightedvalue.md) > [value](./search-core.highlightedvalue.value.md) ## HighlightedValue.value property @@ -14,5 +14,5 @@ value: string; ## Remarks -No formatting is applied to this value. This is simply the value that the Answers API determined should be highlighted. +No formatting is applied to this value. This is simply the value that the Search API determined should be highlighted. diff --git a/docs/answers-core.latlong.latitude.md b/docs/search-core.latlong.latitude.md similarity index 57% rename from docs/answers-core.latlong.latitude.md rename to docs/search-core.latlong.latitude.md index e60d6daa..e14f6946 100644 --- a/docs/answers-core.latlong.latitude.md +++ b/docs/search-core.latlong.latitude.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LatLong](./answers-core.latlong.md) > [latitude](./answers-core.latlong.latitude.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LatLong](./search-core.latlong.md) > [latitude](./search-core.latlong.latitude.md) ## LatLong.latitude property diff --git a/docs/answers-core.latlong.longitude.md b/docs/search-core.latlong.longitude.md similarity index 58% rename from docs/answers-core.latlong.longitude.md rename to docs/search-core.latlong.longitude.md index 1aad6638..48c8ef7c 100644 --- a/docs/answers-core.latlong.longitude.md +++ b/docs/search-core.latlong.longitude.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LatLong](./answers-core.latlong.md) > [longitude](./answers-core.latlong.longitude.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LatLong](./search-core.latlong.md) > [longitude](./search-core.latlong.longitude.md) ## LatLong.longitude property diff --git a/docs/answers-core.latlong.md b/docs/search-core.latlong.md similarity index 53% rename from docs/answers-core.latlong.md rename to docs/search-core.latlong.md index 529a7097..fa01372c 100644 --- a/docs/answers-core.latlong.md +++ b/docs/search-core.latlong.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LatLong](./answers-core.latlong.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LatLong](./search-core.latlong.md) ## LatLong interface @@ -20,6 +20,6 @@ If omitted from a request, Yext will attempt to determine the location. | Property | Type | Description | | --- | --- | --- | -| [latitude](./answers-core.latlong.latitude.md) | number | Latitude formatted as a decimal degree number. | -| [longitude](./answers-core.latlong.longitude.md) | number | Longitude formatted as a decimal degree number. | +| [latitude](./search-core.latlong.latitude.md) | number | Latitude formatted as a decimal degree number. | +| [longitude](./search-core.latlong.longitude.md) | number | Longitude formatted as a decimal degree number. | diff --git a/docs/answers-core.locationbias.displayname.md b/docs/search-core.locationbias.displayname.md similarity index 55% rename from docs/answers-core.locationbias.displayname.md rename to docs/search-core.locationbias.displayname.md index 905ac549..6aa95484 100644 --- a/docs/answers-core.locationbias.displayname.md +++ b/docs/search-core.locationbias.displayname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationBias](./answers-core.locationbias.md) > [displayName](./answers-core.locationbias.displayname.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationBias](./search-core.locationbias.md) > [displayName](./search-core.locationbias.displayname.md) ## LocationBias.displayName property diff --git a/docs/answers-core.locationbias.latitude.md b/docs/search-core.locationbias.latitude.md similarity index 51% rename from docs/answers-core.locationbias.latitude.md rename to docs/search-core.locationbias.latitude.md index 2f19ace0..9df7bbd3 100644 --- a/docs/answers-core.locationbias.latitude.md +++ b/docs/search-core.locationbias.latitude.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationBias](./answers-core.locationbias.md) > [latitude](./answers-core.locationbias.latitude.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationBias](./search-core.locationbias.md) > [latitude](./search-core.locationbias.latitude.md) ## LocationBias.latitude property diff --git a/docs/answers-core.locationbias.longitude.md b/docs/search-core.locationbias.longitude.md similarity index 51% rename from docs/answers-core.locationbias.longitude.md rename to docs/search-core.locationbias.longitude.md index 9714da17..8f4b54a9 100644 --- a/docs/answers-core.locationbias.longitude.md +++ b/docs/search-core.locationbias.longitude.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationBias](./answers-core.locationbias.md) > [longitude](./answers-core.locationbias.longitude.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationBias](./search-core.locationbias.md) > [longitude](./search-core.locationbias.longitude.md) ## LocationBias.longitude property diff --git a/docs/search-core.locationbias.md b/docs/search-core.locationbias.md new file mode 100644 index 00000000..7aea971e --- /dev/null +++ b/docs/search-core.locationbias.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationBias](./search-core.locationbias.md) + +## LocationBias interface + +Information about the user's location. + +Signature: + +```typescript +export interface LocationBias +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [displayName](./search-core.locationbias.displayname.md) | string | The name of the location. | +| [latitude](./search-core.locationbias.latitude.md) | number | The location's latitude. | +| [longitude](./search-core.locationbias.longitude.md) | number | The location's longitude. | +| [method](./search-core.locationbias.method.md) | [LocationBiasMethod](./search-core.locationbiasmethod.md) | The method used to determine the location. | + diff --git a/docs/answers-core.locationbias.method.md b/docs/search-core.locationbias.method.md similarity index 55% rename from docs/answers-core.locationbias.method.md rename to docs/search-core.locationbias.method.md index ec1e247f..5d51cfbc 100644 --- a/docs/answers-core.locationbias.method.md +++ b/docs/search-core.locationbias.method.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationBias](./answers-core.locationbias.md) > [method](./answers-core.locationbias.method.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationBias](./search-core.locationbias.md) > [method](./search-core.locationbias.method.md) ## LocationBias.method property diff --git a/docs/answers-core.locationbiasmethod.md b/docs/search-core.locationbiasmethod.md similarity index 78% rename from docs/answers-core.locationbiasmethod.md rename to docs/search-core.locationbiasmethod.md index 160b8b43..3e66339a 100644 --- a/docs/answers-core.locationbiasmethod.md +++ b/docs/search-core.locationbiasmethod.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationBiasMethod](./answers-core.locationbiasmethod.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationBiasMethod](./search-core.locationbiasmethod.md) ## LocationBiasMethod enum diff --git a/docs/answers-core.locationboundingbox.maxlatitude.md b/docs/search-core.locationboundingbox.maxlatitude.md similarity index 51% rename from docs/answers-core.locationboundingbox.maxlatitude.md rename to docs/search-core.locationboundingbox.maxlatitude.md index 82c59db3..0e8aeec8 100644 --- a/docs/answers-core.locationboundingbox.maxlatitude.md +++ b/docs/search-core.locationboundingbox.maxlatitude.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationBoundingBox](./answers-core.locationboundingbox.md) > [maxLatitude](./answers-core.locationboundingbox.maxlatitude.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationBoundingBox](./search-core.locationboundingbox.md) > [maxLatitude](./search-core.locationboundingbox.maxlatitude.md) ## LocationBoundingBox.maxLatitude property diff --git a/docs/answers-core.locationboundingbox.maxlongitude.md b/docs/search-core.locationboundingbox.maxlongitude.md similarity index 51% rename from docs/answers-core.locationboundingbox.maxlongitude.md rename to docs/search-core.locationboundingbox.maxlongitude.md index c1112c1c..554ead35 100644 --- a/docs/answers-core.locationboundingbox.maxlongitude.md +++ b/docs/search-core.locationboundingbox.maxlongitude.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationBoundingBox](./answers-core.locationboundingbox.md) > [maxLongitude](./answers-core.locationboundingbox.maxlongitude.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationBoundingBox](./search-core.locationboundingbox.md) > [maxLongitude](./search-core.locationboundingbox.maxlongitude.md) ## LocationBoundingBox.maxLongitude property diff --git a/docs/search-core.locationboundingbox.md b/docs/search-core.locationboundingbox.md new file mode 100644 index 00000000..f9b6c269 --- /dev/null +++ b/docs/search-core.locationboundingbox.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationBoundingBox](./search-core.locationboundingbox.md) + +## LocationBoundingBox interface + +Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) + +Signature: + +```typescript +export interface LocationBoundingBox +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [maxLatitude](./search-core.locationboundingbox.maxlatitude.md) | number | The location's highest latitude degree. | +| [maxLongitude](./search-core.locationboundingbox.maxlongitude.md) | number | The location's highest longitude degree. | +| [minLatitude](./search-core.locationboundingbox.minlatitude.md) | number | The location's lowest latitude degree. | +| [minLongitude](./search-core.locationboundingbox.minlongitude.md) | number | The location's lowest longitude degree. | + diff --git a/docs/answers-core.locationboundingbox.minlatitude.md b/docs/search-core.locationboundingbox.minlatitude.md similarity index 51% rename from docs/answers-core.locationboundingbox.minlatitude.md rename to docs/search-core.locationboundingbox.minlatitude.md index 30ce96cb..47eb0ee8 100644 --- a/docs/answers-core.locationboundingbox.minlatitude.md +++ b/docs/search-core.locationboundingbox.minlatitude.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationBoundingBox](./answers-core.locationboundingbox.md) > [minLatitude](./answers-core.locationboundingbox.minlatitude.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationBoundingBox](./search-core.locationboundingbox.md) > [minLatitude](./search-core.locationboundingbox.minlatitude.md) ## LocationBoundingBox.minLatitude property diff --git a/docs/answers-core.locationboundingbox.minlongitude.md b/docs/search-core.locationboundingbox.minlongitude.md similarity index 51% rename from docs/answers-core.locationboundingbox.minlongitude.md rename to docs/search-core.locationboundingbox.minlongitude.md index 0c1a375e..71db1654 100644 --- a/docs/answers-core.locationboundingbox.minlongitude.md +++ b/docs/search-core.locationboundingbox.minlongitude.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationBoundingBox](./answers-core.locationboundingbox.md) > [minLongitude](./answers-core.locationboundingbox.minlongitude.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationBoundingBox](./search-core.locationboundingbox.md) > [minLongitude](./search-core.locationboundingbox.minlongitude.md) ## LocationBoundingBox.minLongitude property diff --git a/docs/answers-core.locationfilterdetails.boundingbox.md b/docs/search-core.locationfilterdetails.boundingbox.md similarity index 52% rename from docs/answers-core.locationfilterdetails.boundingbox.md rename to docs/search-core.locationfilterdetails.boundingbox.md index 139caa94..2e9038be 100644 --- a/docs/answers-core.locationfilterdetails.boundingbox.md +++ b/docs/search-core.locationfilterdetails.boundingbox.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationFilterDetails](./answers-core.locationfilterdetails.md) > [boundingBox](./answers-core.locationfilterdetails.boundingbox.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationFilterDetails](./search-core.locationfilterdetails.md) > [boundingBox](./search-core.locationfilterdetails.boundingbox.md) ## LocationFilterDetails.boundingBox property diff --git a/docs/answers-core.locationfilterdetails.featuretypes.md b/docs/search-core.locationfilterdetails.featuretypes.md similarity index 53% rename from docs/answers-core.locationfilterdetails.featuretypes.md rename to docs/search-core.locationfilterdetails.featuretypes.md index 37f07a14..18e9f42e 100644 --- a/docs/answers-core.locationfilterdetails.featuretypes.md +++ b/docs/search-core.locationfilterdetails.featuretypes.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [LocationFilterDetails](./answers-core.locationfilterdetails.md) > [featureTypes](./answers-core.locationfilterdetails.featuretypes.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationFilterDetails](./search-core.locationfilterdetails.md) > [featureTypes](./search-core.locationfilterdetails.featuretypes.md) ## LocationFilterDetails.featureTypes property diff --git a/docs/search-core.locationfilterdetails.latitude.md b/docs/search-core.locationfilterdetails.latitude.md new file mode 100644 index 00000000..2ff1a48b --- /dev/null +++ b/docs/search-core.locationfilterdetails.latitude.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationFilterDetails](./search-core.locationfilterdetails.md) > [latitude](./search-core.locationfilterdetails.latitude.md) + +## LocationFilterDetails.latitude property + +The location's latitude. + +Signature: + +```typescript +latitude: number; +``` diff --git a/docs/search-core.locationfilterdetails.longitude.md b/docs/search-core.locationfilterdetails.longitude.md new file mode 100644 index 00000000..f2fff5be --- /dev/null +++ b/docs/search-core.locationfilterdetails.longitude.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationFilterDetails](./search-core.locationfilterdetails.md) > [longitude](./search-core.locationfilterdetails.longitude.md) + +## LocationFilterDetails.longitude property + +The location's longitude. + +Signature: + +```typescript +longitude: number; +``` diff --git a/docs/search-core.locationfilterdetails.md b/docs/search-core.locationfilterdetails.md new file mode 100644 index 00000000..0d34e593 --- /dev/null +++ b/docs/search-core.locationfilterdetails.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationFilterDetails](./search-core.locationfilterdetails.md) + +## LocationFilterDetails interface + +Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md). + +Signature: + +```typescript +export interface LocationFilterDetails +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [boundingBox?](./search-core.locationfilterdetails.boundingbox.md) | [LocationBoundingBox](./search-core.locationboundingbox.md) | (Optional) The location's coordinate boundaries. | +| [featureTypes](./search-core.locationfilterdetails.featuretypes.md) | string\[\] | The location's classification (e.g. locality, region, address). | +| [latitude](./search-core.locationfilterdetails.latitude.md) | number | The location's latitude. | +| [longitude](./search-core.locationfilterdetails.longitude.md) | number | The location's longitude. | +| [placeName](./search-core.locationfilterdetails.placename.md) | string | The location's name. | + diff --git a/docs/search-core.locationfilterdetails.placename.md b/docs/search-core.locationfilterdetails.placename.md new file mode 100644 index 00000000..1de42b8a --- /dev/null +++ b/docs/search-core.locationfilterdetails.placename.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LocationFilterDetails](./search-core.locationfilterdetails.md) > [placeName](./search-core.locationfilterdetails.placename.md) + +## LocationFilterDetails.placeName property + +The location's name. + +Signature: + +```typescript +placeName: string; +``` diff --git a/docs/search-core.lowernumberrangelimit.matcher.md b/docs/search-core.lowernumberrangelimit.matcher.md new file mode 100644 index 00000000..1a693110 --- /dev/null +++ b/docs/search-core.lowernumberrangelimit.matcher.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LowerNumberRangeLimit](./search-core.lowernumberrangelimit.md) > [matcher](./search-core.lowernumberrangelimit.matcher.md) + +## LowerNumberRangeLimit.matcher property + +[Matcher](./search-core.matcher.md) for the start limit + +Signature: + +```typescript +matcher: Matcher.GreaterThan | Matcher.GreaterThanOrEqualTo; +``` diff --git a/docs/search-core.lowernumberrangelimit.md b/docs/search-core.lowernumberrangelimit.md new file mode 100644 index 00000000..b7c1b960 --- /dev/null +++ b/docs/search-core.lowernumberrangelimit.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LowerNumberRangeLimit](./search-core.lowernumberrangelimit.md) + +## LowerNumberRangeLimit interface + +The start limit of [NumberRangeValue](./search-core.numberrangevalue.md). + +Signature: + +```typescript +export interface LowerNumberRangeLimit +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [matcher](./search-core.lowernumberrangelimit.matcher.md) | [Matcher.GreaterThan](./search-core.matcher.md) \| [Matcher.GreaterThanOrEqualTo](./search-core.matcher.md) | [Matcher](./search-core.matcher.md) for the start limit | +| [value](./search-core.lowernumberrangelimit.value.md) | number | Value of the limit. | + diff --git a/docs/search-core.lowernumberrangelimit.value.md b/docs/search-core.lowernumberrangelimit.value.md new file mode 100644 index 00000000..2fa066d6 --- /dev/null +++ b/docs/search-core.lowernumberrangelimit.value.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [LowerNumberRangeLimit](./search-core.lowernumberrangelimit.md) > [value](./search-core.lowernumberrangelimit.value.md) + +## LowerNumberRangeLimit.value property + +Value of the limit. + +Signature: + +```typescript +value: number; +``` diff --git a/docs/answers-core.matcher.md b/docs/search-core.matcher.md similarity index 88% rename from docs/answers-core.matcher.md rename to docs/search-core.matcher.md index e2e16e3c..49ee372e 100644 --- a/docs/answers-core.matcher.md +++ b/docs/search-core.matcher.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Matcher](./answers-core.matcher.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Matcher](./search-core.matcher.md) ## Matcher enum diff --git a/docs/search-core.md b/docs/search-core.md new file mode 100644 index 00000000..3b130d7b --- /dev/null +++ b/docs/search-core.md @@ -0,0 +1,114 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) + +## search-core package + +## Classes + +| Class | Description | +| --- | --- | +| [AnswersCore](./search-core.answerscore.md) | | +| [SearchCore](./search-core.searchcore.md) | Provides methods for executing searches, submitting questions, and performing autocompletes. | +| [SearchError](./search-core.searcherror.md) | Represents an error | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./search-core.appliedqueryfilter.md) applied to a search. | +| [DirectAnswerType](./search-core.directanswertype.md) | Represents the type of direct answer. | +| [Direction](./search-core.direction.md) | The direction of a sort. | +| [ErrorType](./search-core.errortype.md) | Identifier for the type of error causing the failure. | +| [FilterCombinator](./search-core.filtercombinator.md) | Indicates how the filters in a [CombinedFilter](./search-core.combinedfilter.md) should be combined. | +| [LocationBiasMethod](./search-core.locationbiasmethod.md) | The method used to determine the location. | +| [Matcher](./search-core.matcher.md) | A Matcher is a filtering operation. | +| [QuerySource](./search-core.querysource.md) | The source of the search request. | +| [QueryTrigger](./search-core.querytrigger.md) | Describes the ways a search can be executed besides user input. | +| [SearchIntent](./search-core.searchintent.md) | Represents intents from the Search API. | +| [SortType](./search-core.sorttype.md) | The method of sorting. | +| [Source](./search-core.source.md) | Represents the source of a [Result](./search-core.result.md). | +| [SpellCheckType](./search-core.spellchecktype.md) | Represents the type of spell check performed. | + +## Functions + +| Function | Description | +| --- | --- | +| [provideCore(config)](./search-core.providecore.md) | The entrypoint to the search-core library. | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [AdditionalHttpHeaders](./search-core.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | +| [AnswersConfigWithApiKey](./search-core.answersconfigwithapikey.md) | | +| [AnswersConfigWithToken](./search-core.answersconfigwithtoken.md) | | +| [AnswersError](./search-core.answerserror.md) | | +| [AnswersRequest](./search-core.answersrequest.md) | | +| [AppliedQueryFilter](./search-core.appliedqueryfilter.md) | A filter that the Search API applied to the search. | +| [AutocompleteResponse](./search-core.autocompleteresponse.md) | The response of a universal or vertical autocomplete request. | +| [AutocompleteResult](./search-core.autocompleteresult.md) | An autocomplete suggestion. | +| [AutocompleteService](./search-core.autocompleteservice.md) | A service for autocomplete requests. | +| [BaseAnswersConfig](./search-core.baseanswersconfig.md) | | +| [BaseSearchConfig](./search-core.basesearchconfig.md) | The base configuration options for [SearchCore](./search-core.searchcore.md). | +| [ClientSDKHeaderValues](./search-core.clientsdkheadervalues.md) | 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. | +| [CombinedFilter](./search-core.combinedfilter.md) | Represents multiple filters that will be combined to refine results. | +| [DirectAnswer](./search-core.directanswer.md) | A direct answer to a search. | +| [DisplayableFacet](./search-core.displayablefacet.md) | A [Facet](./search-core.facet.md) which contains extra fields meant to be displayed to the end user. | +| [DisplayableFacetOption](./search-core.displayablefacetoption.md) | A [FacetOption](./search-core.facetoption.md) with extra data meant to be displayed to the end user. | +| [Endpoints](./search-core.endpoints.md) | Overrides for the URLs which are used when making requests to the Search API. | +| [Facet](./search-core.facet.md) | Represents dynamic filter options for the Search API. | +| [FacetOption](./search-core.facetoption.md) | A filter associated with the facet. | +| [FailedVertical](./search-core.failedvertical.md) | Error information from when a vertical fails to return results. | +| [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) | A direct answer which was found within a document. | +| [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) | A direct answer where the answer came from a field from the knowledge graph. | +| [Filter](./search-core.filter.md) | Represents a filter which compares values to a single field. | +| [FilterSearchRequest](./search-core.filtersearchrequest.md) | Options for a filtersearch request. | +| [FilterSearchResponse](./search-core.filtersearchresponse.md) | The response of a filtersearch request. | +| [HighlightedValue](./search-core.highlightedvalue.md) | A field value and its substring matches as emphasized by the Search API. | +| [LatLong](./search-core.latlong.md) | The latitude and longitude of the user making the request. Used to bias the results. | +| [LocationBias](./search-core.locationbias.md) | Information about the user's location. | +| [LocationBoundingBox](./search-core.locationboundingbox.md) | Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) | +| [LocationFilterDetails](./search-core.locationfilterdetails.md) | Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md). | +| [LowerNumberRangeLimit](./search-core.lowernumberrangelimit.md) | The start limit of [NumberRangeValue](./search-core.numberrangevalue.md). | +| [NearFilterValue](./search-core.nearfiltervalue.md) | A filter value for a filter with a $near [Matcher](./search-core.matcher.md). | +| [NumberRangeValue](./search-core.numberrangevalue.md) | A filter value for a filter with a $between [Matcher](./search-core.matcher.md). | +| [QueryRulesActionsData](./search-core.queryrulesactionsdata.md) | Data returned from the Search query rules system. | +| [QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) | Options for a QuestionSubmission request. | +| [QuestionSubmissionResponse](./search-core.questionsubmissionresponse.md) | A representation of a question submission response. | +| [QuestionSubmissionService](./search-core.questionsubmissionservice.md) | Submits a custom question to the Search API. | +| [Result](./search-core.result.md) | An individual search result. | +| [SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md) | Configuration options for [SearchCore](./search-core.searchcore.md), which includes the options from [BaseSearchConfig](./search-core.basesearchconfig.md), but requires apiKey. | +| [SearchConfigWithToken](./search-core.searchconfigwithtoken.md) | Configuration options for [SearchCore](./search-core.searchcore.md), which includes the options from [BaseSearchConfig](./search-core.basesearchconfig.md), but requires token. | +| [SearchParameterField](./search-core.searchparameterfield.md) | Indicates which entity field to perform the autocomplete request on. | +| [SearchRequest](./search-core.searchrequest.md) | Options for a Search API request. | +| [SearchService](./search-core.searchservice.md) | A service which performs Yext Search. | +| [Snippet](./search-core.snippet.md) | The section of text where a [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) was found. | +| [SortBy](./search-core.sortby.md) | Represents a criterion that can be used to sort results. | +| [SpellCheck](./search-core.spellcheck.md) | A spellcheck response from a search query. | +| [UniversalAutocompleteRequest](./search-core.universalautocompleterequest.md) | Options for a universal autocomplete request. | +| [UniversalLimit](./search-core.universallimit.md) | The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. | +| [UniversalSearchRequest](./search-core.universalsearchrequest.md) | Options which can be specified for a universal search. | +| [UniversalSearchResponse](./search-core.universalsearchresponse.md) | A representation of a response from a universal search. | +| [UpperNumberRangeLimit](./search-core.uppernumberrangelimit.md) | The end limit of [NumberRangeValue](./search-core.numberrangevalue.md). | +| [VerticalAutocompleteRequest](./search-core.verticalautocompleterequest.md) | Options for a vertial autocomplete request. | +| [VerticalResults](./search-core.verticalresults.md) | Represents results from a search vertical. | +| [VerticalSearchRequest](./search-core.verticalsearchrequest.md) | Options which can be specified for a vertical search. | +| [VerticalSearchResponse](./search-core.verticalsearchresponse.md) | A representation of a response from a vertical search. | +| [Visitor](./search-core.visitor.md) | Information used to associate requests with a particular user. | + +## Variables + +| Variable | Description | +| --- | --- | +| [SandboxEndpoints](./search-core.sandboxendpoints.md) | The endpoints to use for sandbox experiences. | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [AnswersConfig](./search-core.answersconfig.md) | | +| [Context](./search-core.context.md) | Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | +| [HighlightedFields](./search-core.highlightedfields.md) | A mapping of fields to the values emphasized by the Search API. | +| [SearchConfig](./search-core.searchconfig.md) | The main configuration options for [SearchCore](./search-core.searchcore.md). For a full description of the options, see [BaseSearchConfig](./search-core.basesearchconfig.md). The config requires either an apiKey or a token. | + diff --git a/docs/answers-core.nearfiltervalue.lat.md b/docs/search-core.nearfiltervalue.lat.md similarity index 51% rename from docs/answers-core.nearfiltervalue.lat.md rename to docs/search-core.nearfiltervalue.lat.md index d5f0d316..a1d42524 100644 --- a/docs/answers-core.nearfiltervalue.lat.md +++ b/docs/search-core.nearfiltervalue.lat.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [NearFilterValue](./answers-core.nearfiltervalue.md) > [lat](./answers-core.nearfiltervalue.lat.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [NearFilterValue](./search-core.nearfiltervalue.md) > [lat](./search-core.nearfiltervalue.lat.md) ## NearFilterValue.lat property diff --git a/docs/answers-core.nearfiltervalue.lng.md b/docs/search-core.nearfiltervalue.lng.md similarity index 51% rename from docs/answers-core.nearfiltervalue.lng.md rename to docs/search-core.nearfiltervalue.lng.md index 8a0421f1..01cee42b 100644 --- a/docs/answers-core.nearfiltervalue.lng.md +++ b/docs/search-core.nearfiltervalue.lng.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [NearFilterValue](./answers-core.nearfiltervalue.md) > [lng](./answers-core.nearfiltervalue.lng.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [NearFilterValue](./search-core.nearfiltervalue.md) > [lng](./search-core.nearfiltervalue.lng.md) ## NearFilterValue.lng property diff --git a/docs/search-core.nearfiltervalue.md b/docs/search-core.nearfiltervalue.md new file mode 100644 index 00000000..9e2bee50 --- /dev/null +++ b/docs/search-core.nearfiltervalue.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [NearFilterValue](./search-core.nearfiltervalue.md) + +## NearFilterValue interface + +A filter value for a filter with a $near [Matcher](./search-core.matcher.md). + +Signature: + +```typescript +export interface NearFilterValue +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [lat](./search-core.nearfiltervalue.lat.md) | number | The latitude of the location. | +| [lng](./search-core.nearfiltervalue.lng.md) | number | The longitude of the location. | +| [radius](./search-core.nearfiltervalue.radius.md) | number | The radius (in meters) around the latitude and longitude. | + diff --git a/docs/answers-core.nearfiltervalue.radius.md b/docs/search-core.nearfiltervalue.radius.md similarity index 54% rename from docs/answers-core.nearfiltervalue.radius.md rename to docs/search-core.nearfiltervalue.radius.md index 0c4c006a..6daf5c3e 100644 --- a/docs/answers-core.nearfiltervalue.radius.md +++ b/docs/search-core.nearfiltervalue.radius.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [NearFilterValue](./answers-core.nearfiltervalue.md) > [radius](./answers-core.nearfiltervalue.radius.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [NearFilterValue](./search-core.nearfiltervalue.md) > [radius](./search-core.nearfiltervalue.radius.md) ## NearFilterValue.radius property diff --git a/docs/answers-core.numberrangevalue.end.md b/docs/search-core.numberrangevalue.end.md similarity index 54% rename from docs/answers-core.numberrangevalue.end.md rename to docs/search-core.numberrangevalue.end.md index 5a5b44ec..01523cfb 100644 --- a/docs/answers-core.numberrangevalue.end.md +++ b/docs/search-core.numberrangevalue.end.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [NumberRangeValue](./answers-core.numberrangevalue.md) > [end](./answers-core.numberrangevalue.end.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [NumberRangeValue](./search-core.numberrangevalue.md) > [end](./search-core.numberrangevalue.end.md) ## NumberRangeValue.end property diff --git a/docs/search-core.numberrangevalue.md b/docs/search-core.numberrangevalue.md new file mode 100644 index 00000000..0a06766a --- /dev/null +++ b/docs/search-core.numberrangevalue.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [NumberRangeValue](./search-core.numberrangevalue.md) + +## NumberRangeValue interface + +A filter value for a filter with a $between [Matcher](./search-core.matcher.md). + +Signature: + +```typescript +export interface NumberRangeValue +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [end?](./search-core.numberrangevalue.end.md) | [UpperNumberRangeLimit](./search-core.uppernumberrangelimit.md) | (Optional) End limit of the number range value. | +| [start?](./search-core.numberrangevalue.start.md) | [LowerNumberRangeLimit](./search-core.lowernumberrangelimit.md) | (Optional) Start limit of the number range value. | + diff --git a/docs/answers-core.numberrangevalue.start.md b/docs/search-core.numberrangevalue.start.md similarity index 54% rename from docs/answers-core.numberrangevalue.start.md rename to docs/search-core.numberrangevalue.start.md index 78dce1c5..d9ae0c01 100644 --- a/docs/answers-core.numberrangevalue.start.md +++ b/docs/search-core.numberrangevalue.start.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [NumberRangeValue](./answers-core.numberrangevalue.md) > [start](./answers-core.numberrangevalue.start.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [NumberRangeValue](./search-core.numberrangevalue.md) > [start](./search-core.numberrangevalue.start.md) ## NumberRangeValue.start property diff --git a/docs/search-core.providecore.md b/docs/search-core.providecore.md new file mode 100644 index 00000000..0af2b04a --- /dev/null +++ b/docs/search-core.providecore.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [provideCore](./search-core.providecore.md) + +## provideCore() function + +The entrypoint to the search-core library. + +Signature: + +```typescript +export declare function provideCore(config: SearchConfig): SearchCore; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| config | [SearchConfig](./search-core.searchconfig.md) | The search-core config | + +Returns: + +[SearchCore](./search-core.searchcore.md) + +## Remarks + +Returns an [SearchCore](./search-core.searchcore.md) instance. + diff --git a/docs/answers-core.queryrulesactionsdata.data.md b/docs/search-core.queryrulesactionsdata.data.md similarity index 53% rename from docs/answers-core.queryrulesactionsdata.data.md rename to docs/search-core.queryrulesactionsdata.data.md index 4118003b..395ffbc3 100644 --- a/docs/answers-core.queryrulesactionsdata.data.md +++ b/docs/search-core.queryrulesactionsdata.data.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QueryRulesActionsData](./answers-core.queryrulesactionsdata.md) > [data](./answers-core.queryrulesactionsdata.data.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QueryRulesActionsData](./search-core.queryrulesactionsdata.md) > [data](./search-core.queryrulesactionsdata.data.md) ## QueryRulesActionsData.data property diff --git a/docs/answers-core.queryrulesactionsdata.errors.md b/docs/search-core.queryrulesactionsdata.errors.md similarity index 57% rename from docs/answers-core.queryrulesactionsdata.errors.md rename to docs/search-core.queryrulesactionsdata.errors.md index c3ba3cba..9e6012fe 100644 --- a/docs/answers-core.queryrulesactionsdata.errors.md +++ b/docs/search-core.queryrulesactionsdata.errors.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QueryRulesActionsData](./answers-core.queryrulesactionsdata.md) > [errors](./answers-core.queryrulesactionsdata.errors.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QueryRulesActionsData](./search-core.queryrulesactionsdata.md) > [errors](./search-core.queryrulesactionsdata.errors.md) ## QueryRulesActionsData.errors property diff --git a/docs/answers-core.queryrulesactionsdata.key.md b/docs/search-core.queryrulesactionsdata.key.md similarity index 51% rename from docs/answers-core.queryrulesactionsdata.key.md rename to docs/search-core.queryrulesactionsdata.key.md index c6b3f497..2c67da8c 100644 --- a/docs/answers-core.queryrulesactionsdata.key.md +++ b/docs/search-core.queryrulesactionsdata.key.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QueryRulesActionsData](./answers-core.queryrulesactionsdata.md) > [key](./answers-core.queryrulesactionsdata.key.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QueryRulesActionsData](./search-core.queryrulesactionsdata.md) > [key](./search-core.queryrulesactionsdata.key.md) ## QueryRulesActionsData.key property diff --git a/docs/search-core.queryrulesactionsdata.md b/docs/search-core.queryrulesactionsdata.md new file mode 100644 index 00000000..2eb777f1 --- /dev/null +++ b/docs/search-core.queryrulesactionsdata.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QueryRulesActionsData](./search-core.queryrulesactionsdata.md) + +## QueryRulesActionsData interface + +Data returned from the Search query rules system. + +Signature: + +```typescript +export interface QueryRulesActionsData +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [data?](./search-core.queryrulesactionsdata.data.md) | Record<string, unknown> | (Optional) The data returned from the query rule. | +| [errors?](./search-core.queryrulesactionsdata.errors.md) | { uuid: string; type: string; message?: string; }\[\] | (Optional) Any errors returned from the query rule. | +| [key](./search-core.queryrulesactionsdata.key.md) | string | The unique identifier for this query rule. | + diff --git a/docs/answers-core.querysource.md b/docs/search-core.querysource.md similarity index 68% rename from docs/answers-core.querysource.md rename to docs/search-core.querysource.md index ebcf96d7..f4b17ddd 100644 --- a/docs/answers-core.querysource.md +++ b/docs/search-core.querysource.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuerySource](./answers-core.querysource.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuerySource](./search-core.querysource.md) ## QuerySource enum @@ -17,6 +17,6 @@ export declare enum QuerySource | Member | Value | Description | | --- | --- | --- | | Autocomplete | "AUTOCOMPLETE" | Indicates that the query was initiated from visual autocomplete. | -| Overlay | "OVERLAY" | Indicates that the query was initiated from an Answers Overlay. | -| Standard | "STANDARD" | Indicates that the query was initiated from a standard Answers integration. | +| Overlay | "OVERLAY" | Indicates that the query was initiated from a Search Overlay. | +| Standard | "STANDARD" | Indicates that the query was initiated from a standard Search integration. | diff --git a/docs/answers-core.querytrigger.md b/docs/search-core.querytrigger.md similarity index 57% rename from docs/answers-core.querytrigger.md rename to docs/search-core.querytrigger.md index 64dd3be3..a16249a0 100644 --- a/docs/answers-core.querytrigger.md +++ b/docs/search-core.querytrigger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QueryTrigger](./answers-core.querytrigger.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QueryTrigger](./search-core.querytrigger.md) ## QueryTrigger enum @@ -17,7 +17,7 @@ export declare enum QueryTrigger | Member | Value | Description | | --- | --- | --- | | Initialize | "initialize" | Indicates that the query was triggered by a default initial search. | -| Suggest | "suggest" | Indicates that the query was suggested by a [SpellCheck](./answers-core.spellcheck.md) response. | +| Suggest | "suggest" | Indicates that the query was suggested by a [SpellCheck](./search-core.spellcheck.md) response. | ## Remarks @@ -25,5 +25,5 @@ Used for search analytics. If a user supplied the search query, do not include a ## Example -An answers site may be configured to perform a search for 'What services do you offer?' when the page loads. Because that query is a default query rather than a user-supplied query, the Initialize QueryTrigger should be included in the request. +A Search site may be configured to perform a search for 'What services do you offer?' when the page loads. Because that query is a default query rather than a user-supplied query, the Initialize QueryTrigger should be included in the request. diff --git a/docs/answers-core.questionsubmissionrequest.email.md b/docs/search-core.questionsubmissionrequest.email.md similarity index 51% rename from docs/answers-core.questionsubmissionrequest.email.md rename to docs/search-core.questionsubmissionrequest.email.md index 7b4ce175..72f4143a 100644 --- a/docs/answers-core.questionsubmissionrequest.email.md +++ b/docs/search-core.questionsubmissionrequest.email.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuestionSubmissionRequest](./answers-core.questionsubmissionrequest.md) > [email](./answers-core.questionsubmissionrequest.email.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) > [email](./search-core.questionsubmissionrequest.email.md) ## QuestionSubmissionRequest.email property diff --git a/docs/answers-core.questionsubmissionrequest.entityid.md b/docs/search-core.questionsubmissionrequest.entityid.md similarity index 51% rename from docs/answers-core.questionsubmissionrequest.entityid.md rename to docs/search-core.questionsubmissionrequest.entityid.md index 8e48e562..d676765c 100644 --- a/docs/answers-core.questionsubmissionrequest.entityid.md +++ b/docs/search-core.questionsubmissionrequest.entityid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuestionSubmissionRequest](./answers-core.questionsubmissionrequest.md) > [entityId](./answers-core.questionsubmissionrequest.entityid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) > [entityId](./search-core.questionsubmissionrequest.entityid.md) ## QuestionSubmissionRequest.entityId property diff --git a/docs/search-core.questionsubmissionrequest.md b/docs/search-core.questionsubmissionrequest.md new file mode 100644 index 00000000..63d6df3f --- /dev/null +++ b/docs/search-core.questionsubmissionrequest.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) + +## QuestionSubmissionRequest interface + +Options for a QuestionSubmission request. + +Signature: + +```typescript +export interface QuestionSubmissionRequest extends SearchRequest +``` +Extends: [SearchRequest](./search-core.searchrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [email](./search-core.questionsubmissionrequest.email.md) | string | The email of the user that is submitting the question. | +| [entityId](./search-core.questionsubmissionrequest.entityid.md) | string | The ID of the entity to associate with the question. | +| [name](./search-core.questionsubmissionrequest.name.md) | string | The name of the user. | +| [questionDescription?](./search-core.questionsubmissionrequest.questiondescription.md) | string | (Optional) Additional information about the question. | +| [questionText](./search-core.questionsubmissionrequest.questiontext.md) | string | The question. | +| [sessionTrackingEnabled?](./search-core.questionsubmissionrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | + diff --git a/docs/search-core.questionsubmissionrequest.name.md b/docs/search-core.questionsubmissionrequest.name.md new file mode 100644 index 00000000..0141acfb --- /dev/null +++ b/docs/search-core.questionsubmissionrequest.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) > [name](./search-core.questionsubmissionrequest.name.md) + +## QuestionSubmissionRequest.name property + +The name of the user. + +Signature: + +```typescript +name: string; +``` diff --git a/docs/answers-core.questionsubmissionrequest.questiondescription.md b/docs/search-core.questionsubmissionrequest.questiondescription.md similarity index 50% rename from docs/answers-core.questionsubmissionrequest.questiondescription.md rename to docs/search-core.questionsubmissionrequest.questiondescription.md index 7e1ddff8..737b7aef 100644 --- a/docs/answers-core.questionsubmissionrequest.questiondescription.md +++ b/docs/search-core.questionsubmissionrequest.questiondescription.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuestionSubmissionRequest](./answers-core.questionsubmissionrequest.md) > [questionDescription](./answers-core.questionsubmissionrequest.questiondescription.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) > [questionDescription](./search-core.questionsubmissionrequest.questiondescription.md) ## QuestionSubmissionRequest.questionDescription property diff --git a/docs/search-core.questionsubmissionrequest.questiontext.md b/docs/search-core.questionsubmissionrequest.questiontext.md new file mode 100644 index 00000000..ad083d07 --- /dev/null +++ b/docs/search-core.questionsubmissionrequest.questiontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) > [questionText](./search-core.questionsubmissionrequest.questiontext.md) + +## QuestionSubmissionRequest.questionText property + +The question. + +Signature: + +```typescript +questionText: string; +``` diff --git a/docs/search-core.questionsubmissionrequest.sessiontrackingenabled.md b/docs/search-core.questionsubmissionrequest.sessiontrackingenabled.md new file mode 100644 index 00000000..3333ad37 --- /dev/null +++ b/docs/search-core.questionsubmissionrequest.sessiontrackingenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) > [sessionTrackingEnabled](./search-core.questionsubmissionrequest.sessiontrackingenabled.md) + +## QuestionSubmissionRequest.sessionTrackingEnabled property + +Enables session tracking. + +Signature: + +```typescript +sessionTrackingEnabled?: boolean; +``` diff --git a/docs/answers-core.questionsubmissionresponse.md b/docs/search-core.questionsubmissionresponse.md similarity index 53% rename from docs/answers-core.questionsubmissionresponse.md rename to docs/search-core.questionsubmissionresponse.md index 890e7997..9548241f 100644 --- a/docs/answers-core.questionsubmissionresponse.md +++ b/docs/search-core.questionsubmissionresponse.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuestionSubmissionResponse](./answers-core.questionsubmissionresponse.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuestionSubmissionResponse](./search-core.questionsubmissionresponse.md) ## QuestionSubmissionResponse interface @@ -16,5 +16,5 @@ export interface QuestionSubmissionResponse | Property | Type | Description | | --- | --- | --- | -| [uuid](./answers-core.questionsubmissionresponse.uuid.md) | string | A unique id which corresponds to the request. | +| [uuid](./search-core.questionsubmissionresponse.uuid.md) | string | A unique id which corresponds to the request. | diff --git a/docs/answers-core.questionsubmissionresponse.uuid.md b/docs/search-core.questionsubmissionresponse.uuid.md similarity index 50% rename from docs/answers-core.questionsubmissionresponse.uuid.md rename to docs/search-core.questionsubmissionresponse.uuid.md index ab79e11c..f39f1720 100644 --- a/docs/answers-core.questionsubmissionresponse.uuid.md +++ b/docs/search-core.questionsubmissionresponse.uuid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [QuestionSubmissionResponse](./answers-core.questionsubmissionresponse.md) > [uuid](./answers-core.questionsubmissionresponse.uuid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuestionSubmissionResponse](./search-core.questionsubmissionresponse.md) > [uuid](./search-core.questionsubmissionresponse.uuid.md) ## QuestionSubmissionResponse.uuid property diff --git a/docs/search-core.questionsubmissionservice.md b/docs/search-core.questionsubmissionservice.md new file mode 100644 index 00000000..88a3d82f --- /dev/null +++ b/docs/search-core.questionsubmissionservice.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuestionSubmissionService](./search-core.questionsubmissionservice.md) + +## QuestionSubmissionService interface + +Submits a custom question to the Search API. + +Signature: + +```typescript +export interface QuestionSubmissionService +``` + +## Methods + +| Method | Description | +| --- | --- | +| [submitQuestion(request)](./search-core.questionsubmissionservice.submitquestion.md) | Submits a question to be answered. | + diff --git a/docs/search-core.questionsubmissionservice.submitquestion.md b/docs/search-core.questionsubmissionservice.submitquestion.md new file mode 100644 index 00000000..3e07e4a1 --- /dev/null +++ b/docs/search-core.questionsubmissionservice.submitquestion.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [QuestionSubmissionService](./search-core.questionsubmissionservice.md) > [submitQuestion](./search-core.questionsubmissionservice.submitquestion.md) + +## QuestionSubmissionService.submitQuestion() method + +Submits a question to be answered. + +Signature: + +```typescript +submitQuestion(request: QuestionSubmissionRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) | The question, as well as the contact info of the submitter. | + +Returns: + +Promise<[QuestionSubmissionResponse](./search-core.questionsubmissionresponse.md)> + diff --git a/docs/answers-core.result.description.md b/docs/search-core.result.description.md similarity index 53% rename from docs/answers-core.result.description.md rename to docs/search-core.result.description.md index 4a223ed6..8ecf689a 100644 --- a/docs/answers-core.result.description.md +++ b/docs/search-core.result.description.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) > [description](./answers-core.result.description.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) > [description](./search-core.result.description.md) ## Result.description property diff --git a/docs/answers-core.result.distance.md b/docs/search-core.result.distance.md similarity index 56% rename from docs/answers-core.result.distance.md rename to docs/search-core.result.distance.md index 0d15a8c2..fc4792e4 100644 --- a/docs/answers-core.result.distance.md +++ b/docs/search-core.result.distance.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) > [distance](./answers-core.result.distance.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) > [distance](./search-core.result.distance.md) ## Result.distance property diff --git a/docs/answers-core.result.distancefromfilter.md b/docs/search-core.result.distancefromfilter.md similarity index 58% rename from docs/answers-core.result.distancefromfilter.md rename to docs/search-core.result.distancefromfilter.md index 3b8e8767..998d935d 100644 --- a/docs/answers-core.result.distancefromfilter.md +++ b/docs/search-core.result.distancefromfilter.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) > [distanceFromFilter](./answers-core.result.distancefromfilter.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) > [distanceFromFilter](./search-core.result.distancefromfilter.md) ## Result.distanceFromFilter property -The distance from a [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) location to the result in meters. +The distance from a [AppliedQueryFilter](./search-core.appliedqueryfilter.md) location to the result in meters. Signature: @@ -14,7 +14,7 @@ distanceFromFilter?: number; ## Remarks -The filter may be an inferred from the search query, or it may be specified explicitly through a facet or static filter on a [VerticalSearchRequest](./answers-core.verticalsearchrequest.md). +The filter may be an inferred from the search query, or it may be specified explicitly through a facet or static filter on a [VerticalSearchRequest](./search-core.verticalsearchrequest.md). ## Example diff --git a/docs/answers-core.result.entitytype.md b/docs/search-core.result.entitytype.md similarity index 54% rename from docs/answers-core.result.entitytype.md rename to docs/search-core.result.entitytype.md index e7626b24..b28161d0 100644 --- a/docs/answers-core.result.entitytype.md +++ b/docs/search-core.result.entitytype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) > [entityType](./answers-core.result.entitytype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) > [entityType](./search-core.result.entitytype.md) ## Result.entityType property diff --git a/docs/search-core.result.highlightedfields.md b/docs/search-core.result.highlightedfields.md new file mode 100644 index 00000000..6c434055 --- /dev/null +++ b/docs/search-core.result.highlightedfields.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) > [highlightedFields](./search-core.result.highlightedfields.md) + +## Result.highlightedFields property + +The [highlighted fields](./search-core.highlightedfields.md) emphasized by the api. + +Signature: + +```typescript +highlightedFields?: HighlightedFields; +``` diff --git a/docs/answers-core.result.id.md b/docs/search-core.result.id.md similarity index 57% rename from docs/answers-core.result.id.md rename to docs/search-core.result.id.md index 26b9bce2..87e3fca4 100644 --- a/docs/answers-core.result.id.md +++ b/docs/search-core.result.id.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) > [id](./answers-core.result.id.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) > [id](./search-core.result.id.md) ## Result.id property diff --git a/docs/answers-core.result.index.md b/docs/search-core.result.index.md similarity index 58% rename from docs/answers-core.result.index.md rename to docs/search-core.result.index.md index 0654507c..8fb94111 100644 --- a/docs/answers-core.result.index.md +++ b/docs/search-core.result.index.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) > [index](./answers-core.result.index.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) > [index](./search-core.result.index.md) ## Result.index property diff --git a/docs/answers-core.result.link.md b/docs/search-core.result.link.md similarity index 55% rename from docs/answers-core.result.link.md rename to docs/search-core.result.link.md index 20266341..6d5e6f69 100644 --- a/docs/answers-core.result.link.md +++ b/docs/search-core.result.link.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) > [link](./answers-core.result.link.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) > [link](./search-core.result.link.md) ## Result.link property diff --git a/docs/search-core.result.md b/docs/search-core.result.md new file mode 100644 index 00000000..0c27bbc5 --- /dev/null +++ b/docs/search-core.result.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) + +## Result interface + +An individual search result. + +Signature: + +```typescript +export interface Result +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [description?](./search-core.result.description.md) | string | (Optional) A description of the result. | +| [distance?](./search-core.result.distance.md) | number | (Optional) The distance from the user to the result in meters. | +| [distanceFromFilter?](./search-core.result.distancefromfilter.md) | number | (Optional) The distance from a [AppliedQueryFilter](./search-core.appliedqueryfilter.md) location to the result in meters. | +| [entityType?](./search-core.result.entitytype.md) | string | (Optional) The entity type of the result | +| [highlightedFields?](./search-core.result.highlightedfields.md) | [HighlightedFields](./search-core.highlightedfields.md) | (Optional) The [highlighted fields](./search-core.highlightedfields.md) emphasized by the api. | +| [id?](./search-core.result.id.md) | string | (Optional) The result ID which depends on the Result Source. | +| [index?](./search-core.result.index.md) | number | (Optional) The index of the result among the other results in the search. | +| [link?](./search-core.result.link.md) | string | (Optional) A hyperlink associated with the result. | +| [name?](./search-core.result.name.md) | string | (Optional) The name of the result. | +| [rawData](./search-core.result.rawdata.md) | Record<string, unknown> | Raw entity profile data in the shape of key-value pairs. | +| [source](./search-core.result.source.md) | [Source](./search-core.source.md) | Represents the source of a [Result](./search-core.result.md). | + diff --git a/docs/answers-core.result.name.md b/docs/search-core.result.name.md similarity index 53% rename from docs/answers-core.result.name.md rename to docs/search-core.result.name.md index 2ee66f73..2673fa3e 100644 --- a/docs/answers-core.result.name.md +++ b/docs/search-core.result.name.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) > [name](./answers-core.result.name.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) > [name](./search-core.result.name.md) ## Result.name property diff --git a/docs/answers-core.result.rawdata.md b/docs/search-core.result.rawdata.md similarity index 59% rename from docs/answers-core.result.rawdata.md rename to docs/search-core.result.rawdata.md index b945bd43..ba4687c5 100644 --- a/docs/answers-core.result.rawdata.md +++ b/docs/search-core.result.rawdata.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Result](./answers-core.result.md) > [rawData](./answers-core.result.rawdata.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) > [rawData](./search-core.result.rawdata.md) ## Result.rawData property diff --git a/docs/search-core.result.source.md b/docs/search-core.result.source.md new file mode 100644 index 00000000..86de29c8 --- /dev/null +++ b/docs/search-core.result.source.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Result](./search-core.result.md) > [source](./search-core.result.source.md) + +## Result.source property + +Represents the source of a [Result](./search-core.result.md). + +Signature: + +```typescript +source: Source; +``` diff --git a/docs/answers-core.sandboxendpoints.md b/docs/search-core.sandboxendpoints.md similarity index 63% rename from docs/answers-core.sandboxendpoints.md rename to docs/search-core.sandboxendpoints.md index 1dcaad2f..4b28fa12 100644 --- a/docs/answers-core.sandboxendpoints.md +++ b/docs/search-core.sandboxendpoints.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SandboxEndpoints](./answers-core.sandboxendpoints.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SandboxEndpoints](./search-core.sandboxendpoints.md) ## SandboxEndpoints variable diff --git a/docs/search-core.searchconfig.md b/docs/search-core.searchconfig.md new file mode 100644 index 00000000..56d994c6 --- /dev/null +++ b/docs/search-core.searchconfig.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchConfig](./search-core.searchconfig.md) + +## SearchConfig type + +The main configuration options for [SearchCore](./search-core.searchcore.md). For a full description of the options, see [BaseSearchConfig](./search-core.basesearchconfig.md). The config requires either an apiKey or a token. + +Signature: + +```typescript +export declare type SearchConfig = SearchConfigWithApiKey | SearchConfigWithToken; +``` +References: [SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md), [SearchConfigWithToken](./search-core.searchconfigwithtoken.md) + diff --git a/docs/search-core.searchconfigwithapikey.apikey.md b/docs/search-core.searchconfigwithapikey.apikey.md new file mode 100644 index 00000000..70d57f73 --- /dev/null +++ b/docs/search-core.searchconfigwithapikey.apikey.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md) > [apiKey](./search-core.searchconfigwithapikey.apikey.md) + +## SearchConfigWithApiKey.apiKey property + +The api key of the search experience which will be sent as a query param. + +Signature: + +```typescript +apiKey: string; +``` diff --git a/docs/search-core.searchconfigwithapikey.md b/docs/search-core.searchconfigwithapikey.md new file mode 100644 index 00000000..91282f36 --- /dev/null +++ b/docs/search-core.searchconfigwithapikey.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md) + +## SearchConfigWithApiKey interface + +Configuration options for [SearchCore](./search-core.searchcore.md), which includes the options from [BaseSearchConfig](./search-core.basesearchconfig.md), but requires apiKey. + +Signature: + +```typescript +export interface SearchConfigWithApiKey extends BaseSearchConfig +``` +Extends: [BaseSearchConfig](./search-core.basesearchconfig.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [apiKey](./search-core.searchconfigwithapikey.apikey.md) | string | The api key of the search experience which will be sent as a query param. | +| [token?](./search-core.searchconfigwithapikey.token.md) | never | (Optional) token should NOT be provided along with apiKey. | + diff --git a/docs/search-core.searchconfigwithapikey.token.md b/docs/search-core.searchconfigwithapikey.token.md new file mode 100644 index 00000000..4988ccb3 --- /dev/null +++ b/docs/search-core.searchconfigwithapikey.token.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md) > [token](./search-core.searchconfigwithapikey.token.md) + +## SearchConfigWithApiKey.token property + +token should NOT be provided along with apiKey. + +Signature: + +```typescript +token?: never; +``` diff --git a/docs/search-core.searchconfigwithtoken.apikey.md b/docs/search-core.searchconfigwithtoken.apikey.md new file mode 100644 index 00000000..366787bf --- /dev/null +++ b/docs/search-core.searchconfigwithtoken.apikey.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchConfigWithToken](./search-core.searchconfigwithtoken.md) > [apiKey](./search-core.searchconfigwithtoken.apikey.md) + +## SearchConfigWithToken.apiKey property + +apiKey should NOT be provided along with token. + +Signature: + +```typescript +apiKey?: never; +``` diff --git a/docs/search-core.searchconfigwithtoken.md b/docs/search-core.searchconfigwithtoken.md new file mode 100644 index 00000000..416a957b --- /dev/null +++ b/docs/search-core.searchconfigwithtoken.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchConfigWithToken](./search-core.searchconfigwithtoken.md) + +## SearchConfigWithToken interface + +Configuration options for [SearchCore](./search-core.searchcore.md), which includes the options from [BaseSearchConfig](./search-core.basesearchconfig.md), but requires token. + +Signature: + +```typescript +export interface SearchConfigWithToken extends BaseSearchConfig +``` +Extends: [BaseSearchConfig](./search-core.basesearchconfig.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [apiKey?](./search-core.searchconfigwithtoken.apikey.md) | never | (Optional) apiKey should NOT be provided along with token. | +| [token](./search-core.searchconfigwithtoken.token.md) | string | The authentication token of the search experience which will be passed in the Auth header as a Bearer token. | + diff --git a/docs/search-core.searchconfigwithtoken.token.md b/docs/search-core.searchconfigwithtoken.token.md new file mode 100644 index 00000000..2de2d85c --- /dev/null +++ b/docs/search-core.searchconfigwithtoken.token.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchConfigWithToken](./search-core.searchconfigwithtoken.md) > [token](./search-core.searchconfigwithtoken.token.md) + +## SearchConfigWithToken.token property + +The authentication token of the search experience which will be passed in the Auth header as a Bearer token. + +Signature: + +```typescript +token: string; +``` diff --git a/docs/search-core.searchcore._constructor_.md b/docs/search-core.searchcore._constructor_.md new file mode 100644 index 00000000..bb953b2a --- /dev/null +++ b/docs/search-core.searchcore._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchCore](./search-core.searchcore.md) > [(constructor)](./search-core.searchcore._constructor_.md) + +## SearchCore.(constructor) + +Constructs a new instance of the `SearchCore` class + +Signature: + +```typescript +constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| searchService | [SearchService](./search-core.searchservice.md) | | +| questionSubmissionService | [QuestionSubmissionService](./search-core.questionsubmissionservice.md) | | +| autoCompleteService | [AutocompleteService](./search-core.autocompleteservice.md) | | + diff --git a/docs/answers-core.answerscore.filtersearch.md b/docs/search-core.searchcore.filtersearch.md similarity index 62% rename from docs/answers-core.answerscore.filtersearch.md rename to docs/search-core.searchcore.filtersearch.md index 567551d7..57bbe557 100644 --- a/docs/answers-core.answerscore.filtersearch.md +++ b/docs/search-core.searchcore.filtersearch.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [AnswersCore](./answers-core.answerscore.md) > [filterSearch](./answers-core.answerscore.filtersearch.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchCore](./search-core.searchcore.md) > [filterSearch](./search-core.searchcore.filtersearch.md) -## AnswersCore.filterSearch() method +## SearchCore.filterSearch() method Performs a filtersearch request against specified fields within a single vertical. @@ -16,15 +16,15 @@ filterSearch(request: FilterSearchRequest): Promise; | Parameter | Type | Description | | --- | --- | --- | -| request | [FilterSearchRequest](./answers-core.filtersearchrequest.md) | filtersearch request options | +| request | [FilterSearchRequest](./search-core.filtersearchrequest.md) | filtersearch request options | Returns: -Promise<[FilterSearchResponse](./answers-core.filtersearchresponse.md)> +Promise<[FilterSearchResponse](./search-core.filtersearchresponse.md)> ## Remarks -This differs from the vertical autocomplete because the vertical autocomplete operates on all entity fields whereas filtersearch operates only on specified fields. If rejected, the reason will be an [AnswersError](./answers-core.answerserror.md). +This differs from the vertical autocomplete because the vertical autocomplete operates on all entity fields whereas filtersearch operates only on specified fields. If rejected, the reason will be an [SearchError](./search-core.searcherror.md). ## Example diff --git a/docs/search-core.searchcore.md b/docs/search-core.searchcore.md new file mode 100644 index 00000000..a1b22d20 --- /dev/null +++ b/docs/search-core.searchcore.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchCore](./search-core.searchcore.md) + +## SearchCore class + +Provides methods for executing searches, submitting questions, and performing autocompletes. + +Signature: + +```typescript +export declare class SearchCore +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(searchService, questionSubmissionService, autoCompleteService)](./search-core.searchcore._constructor_.md) | | Constructs a new instance of the SearchCore class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [filterSearch(request)](./search-core.searchcore.filtersearch.md) | | Performs a filtersearch request against specified fields within a single vertical. | +| [submitQuestion(request)](./search-core.searchcore.submitquestion.md) | | Submits a custom question to the Search API. | +| [universalAutocomplete(request)](./search-core.searchcore.universalautocomplete.md) | | Performs an autocomplete request across all verticals. | +| [universalSearch(request)](./search-core.searchcore.universalsearch.md) | | Performs a search across all verticals. | +| [verticalAutocomplete(request)](./search-core.searchcore.verticalautocomplete.md) | | Performs an autocomplete request for a single vertical. | +| [verticalSearch(request)](./search-core.searchcore.verticalsearch.md) | | Performs a search for a single vertical. | + diff --git a/docs/search-core.searchcore.submitquestion.md b/docs/search-core.searchcore.submitquestion.md new file mode 100644 index 00000000..788bc692 --- /dev/null +++ b/docs/search-core.searchcore.submitquestion.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchCore](./search-core.searchcore.md) > [submitQuestion](./search-core.searchcore.submitquestion.md) + +## SearchCore.submitQuestion() method + +Submits a custom question to the Search API. + +Signature: + +```typescript +submitQuestion(request: QuestionSubmissionRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) | Question submission request options | + +Returns: + +Promise<[QuestionSubmissionResponse](./search-core.questionsubmissionresponse.md)> + +## Remarks + +If rejected, the reason will be an [SearchError](./search-core.searcherror.md). + diff --git a/docs/search-core.searchcore.universalautocomplete.md b/docs/search-core.searchcore.universalautocomplete.md new file mode 100644 index 00000000..444c7cf6 --- /dev/null +++ b/docs/search-core.searchcore.universalautocomplete.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchCore](./search-core.searchcore.md) > [universalAutocomplete](./search-core.searchcore.universalautocomplete.md) + +## SearchCore.universalAutocomplete() method + +Performs an autocomplete request across all verticals. + +Signature: + +```typescript +universalAutocomplete(request: UniversalAutocompleteRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [UniversalAutocompleteRequest](./search-core.universalautocompleterequest.md) | Universal autocomplete request options | + +Returns: + +Promise<[AutocompleteResponse](./search-core.autocompleteresponse.md)> + +## Remarks + +If rejected, the reason will be an [SearchError](./search-core.searcherror.md). + diff --git a/docs/search-core.searchcore.universalsearch.md b/docs/search-core.searchcore.universalsearch.md new file mode 100644 index 00000000..81899183 --- /dev/null +++ b/docs/search-core.searchcore.universalsearch.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchCore](./search-core.searchcore.md) > [universalSearch](./search-core.searchcore.universalsearch.md) + +## SearchCore.universalSearch() method + +Performs a search across all verticals. + +Signature: + +```typescript +universalSearch(request: UniversalSearchRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [UniversalSearchRequest](./search-core.universalsearchrequest.md) | Universal search request options | + +Returns: + +Promise<[UniversalSearchResponse](./search-core.universalsearchresponse.md)> + +## Remarks + +If rejected, the reason will be an [SearchError](./search-core.searcherror.md). + diff --git a/docs/search-core.searchcore.verticalautocomplete.md b/docs/search-core.searchcore.verticalautocomplete.md new file mode 100644 index 00000000..99ff44f3 --- /dev/null +++ b/docs/search-core.searchcore.verticalautocomplete.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchCore](./search-core.searchcore.md) > [verticalAutocomplete](./search-core.searchcore.verticalautocomplete.md) + +## SearchCore.verticalAutocomplete() method + +Performs an autocomplete request for a single vertical. + +Signature: + +```typescript +verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [VerticalAutocompleteRequest](./search-core.verticalautocompleterequest.md) | Vertical autocomplete request options | + +Returns: + +Promise<[AutocompleteResponse](./search-core.autocompleteresponse.md)> + +## Remarks + +If rejected, the reason will be an [SearchError](./search-core.searcherror.md). + diff --git a/docs/search-core.searchcore.verticalsearch.md b/docs/search-core.searchcore.verticalsearch.md new file mode 100644 index 00000000..64e6fcfb --- /dev/null +++ b/docs/search-core.searchcore.verticalsearch.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchCore](./search-core.searchcore.md) > [verticalSearch](./search-core.searchcore.verticalsearch.md) + +## SearchCore.verticalSearch() method + +Performs a search for a single vertical. + +Signature: + +```typescript +verticalSearch(request: VerticalSearchRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [VerticalSearchRequest](./search-core.verticalsearchrequest.md) | Vertical search request options | + +Returns: + +Promise<[VerticalSearchResponse](./search-core.verticalsearchresponse.md)> + +## Remarks + +If rejected, the reason will be an [SearchError](./search-core.searcherror.md). + diff --git a/docs/search-core.searcherror.code.md b/docs/search-core.searcherror.code.md new file mode 100644 index 00000000..43ecb5be --- /dev/null +++ b/docs/search-core.searcherror.code.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchError](./search-core.searcherror.md) > [code](./search-core.searcherror.code.md) + +## SearchError.code property + +Search API error code. + +Signature: + +```typescript +code?: number; +``` diff --git a/docs/search-core.searcherror.md b/docs/search-core.searcherror.md new file mode 100644 index 00000000..41c90f5c --- /dev/null +++ b/docs/search-core.searcherror.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchError](./search-core.searcherror.md) + +## SearchError class + +Represents an error + +Signature: + +```typescript +export declare class SearchError extends Error +``` +Extends: Error + +## Remarks + +If the error originates from the Search API, the code and type property will be present. + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SearchError` class. + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [code?](./search-core.searcherror.code.md) | | number | (Optional) Search API error code. | +| [message](./search-core.searcherror.message.md) | | string | The error message. | +| [type?](./search-core.searcherror.type.md) | | string | (Optional) Search API error type. | + diff --git a/docs/search-core.searcherror.message.md b/docs/search-core.searcherror.message.md new file mode 100644 index 00000000..15e0aa35 --- /dev/null +++ b/docs/search-core.searcherror.message.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchError](./search-core.searcherror.md) > [message](./search-core.searcherror.message.md) + +## SearchError.message property + +The error message. + +Signature: + +```typescript +message: string; +``` diff --git a/docs/search-core.searcherror.type.md b/docs/search-core.searcherror.type.md new file mode 100644 index 00000000..7934d231 --- /dev/null +++ b/docs/search-core.searcherror.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchError](./search-core.searcherror.md) > [type](./search-core.searcherror.type.md) + +## SearchError.type property + +Search API error type. + +Signature: + +```typescript +type?: string; +``` diff --git a/docs/search-core.searchintent.md b/docs/search-core.searchintent.md new file mode 100644 index 00000000..4da29161 --- /dev/null +++ b/docs/search-core.searchintent.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchIntent](./search-core.searchintent.md) + +## SearchIntent enum + +Represents intents from the Search API. + +Signature: + +```typescript +export declare enum SearchIntent +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| NearMe | "NEAR_ME" | The Search API is requesting a prompt for the user's location. | + diff --git a/docs/answers-core.searchparameterfield.entitytype.md b/docs/search-core.searchparameterfield.entitytype.md similarity index 52% rename from docs/answers-core.searchparameterfield.entitytype.md rename to docs/search-core.searchparameterfield.entitytype.md index c82a021b..972ad2ce 100644 --- a/docs/answers-core.searchparameterfield.entitytype.md +++ b/docs/search-core.searchparameterfield.entitytype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SearchParameterField](./answers-core.searchparameterfield.md) > [entityType](./answers-core.searchparameterfield.entitytype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchParameterField](./search-core.searchparameterfield.md) > [entityType](./search-core.searchparameterfield.entitytype.md) ## SearchParameterField.entityType property diff --git a/docs/search-core.searchparameterfield.fetchentities.md b/docs/search-core.searchparameterfield.fetchentities.md new file mode 100644 index 00000000..6098ce91 --- /dev/null +++ b/docs/search-core.searchparameterfield.fetchentities.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchParameterField](./search-core.searchparameterfield.md) > [fetchEntities](./search-core.searchparameterfield.fetchentities.md) + +## SearchParameterField.fetchEntities property + +Indicates whether or not to return the [AutocompleteResult.relatedItem](./search-core.autocompleteresult.relateditem.md) associated with the autocomplete result. + +Signature: + +```typescript +fetchEntities: boolean; +``` diff --git a/docs/answers-core.searchparameterfield.fieldapiname.md b/docs/search-core.searchparameterfield.fieldapiname.md similarity index 52% rename from docs/answers-core.searchparameterfield.fieldapiname.md rename to docs/search-core.searchparameterfield.fieldapiname.md index 23576377..795fe363 100644 --- a/docs/answers-core.searchparameterfield.fieldapiname.md +++ b/docs/search-core.searchparameterfield.fieldapiname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SearchParameterField](./answers-core.searchparameterfield.md) > [fieldApiName](./answers-core.searchparameterfield.fieldapiname.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchParameterField](./search-core.searchparameterfield.md) > [fieldApiName](./search-core.searchparameterfield.fieldapiname.md) ## SearchParameterField.fieldApiName property diff --git a/docs/search-core.searchparameterfield.md b/docs/search-core.searchparameterfield.md new file mode 100644 index 00000000..e47a5e0e --- /dev/null +++ b/docs/search-core.searchparameterfield.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchParameterField](./search-core.searchparameterfield.md) + +## SearchParameterField interface + +Indicates which entity field to perform the autocomplete request on. + +Signature: + +```typescript +export interface SearchParameterField +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [entityType](./search-core.searchparameterfield.entitytype.md) | string | The entityType to perform the autocomplete on. | +| [fetchEntities](./search-core.searchparameterfield.fetchentities.md) | boolean | Indicates whether or not to return the [AutocompleteResult.relatedItem](./search-core.autocompleteresult.relateditem.md) associated with the autocomplete result. | +| [fieldApiName](./search-core.searchparameterfield.fieldapiname.md) | string | The fieldApiName to perform the autocomplete on. | + diff --git a/docs/search-core.searchrequest.additionalhttpheaders.md b/docs/search-core.searchrequest.additionalhttpheaders.md new file mode 100644 index 00000000..0b3508e0 --- /dev/null +++ b/docs/search-core.searchrequest.additionalhttpheaders.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchRequest](./search-core.searchrequest.md) > [additionalHttpHeaders](./search-core.searchrequest.additionalhttpheaders.md) + +## SearchRequest.additionalHttpHeaders property + +AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. + +Signature: + +```typescript +additionalHttpHeaders?: AdditionalHttpHeaders; +``` diff --git a/docs/search-core.searchrequest.md b/docs/search-core.searchrequest.md new file mode 100644 index 00000000..bb9cfb31 --- /dev/null +++ b/docs/search-core.searchrequest.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchRequest](./search-core.searchrequest.md) + +## SearchRequest interface + +Options for a Search API request. + +Signature: + +```typescript +export interface SearchRequest +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [additionalHttpHeaders?](./search-core.searchrequest.additionalhttpheaders.md) | [AdditionalHttpHeaders](./search-core.additionalhttpheaders.md) | (Optional) AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | + diff --git a/docs/search-core.searchservice.md b/docs/search-core.searchservice.md new file mode 100644 index 00000000..4b5f6ff4 --- /dev/null +++ b/docs/search-core.searchservice.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchService](./search-core.searchservice.md) + +## SearchService interface + +A service which performs Yext Search. + +Signature: + +```typescript +export interface SearchService +``` + +## Methods + +| Method | Description | +| --- | --- | +| [universalSearch(request)](./search-core.searchservice.universalsearch.md) | Performs a Universal search across all verticals. | +| [verticalSearch(request)](./search-core.searchservice.verticalsearch.md) | Performs a search across a particular Vertical. | + diff --git a/docs/search-core.searchservice.universalsearch.md b/docs/search-core.searchservice.universalsearch.md new file mode 100644 index 00000000..438b8ee8 --- /dev/null +++ b/docs/search-core.searchservice.universalsearch.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchService](./search-core.searchservice.md) > [universalSearch](./search-core.searchservice.universalsearch.md) + +## SearchService.universalSearch() method + +Performs a Universal search across all verticals. + +Signature: + +```typescript +universalSearch(request: UniversalSearchRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [UniversalSearchRequest](./search-core.universalsearchrequest.md) | The details of the Universal search request. | + +Returns: + +Promise<[UniversalSearchResponse](./search-core.universalsearchresponse.md)> + diff --git a/docs/search-core.searchservice.verticalsearch.md b/docs/search-core.searchservice.verticalsearch.md new file mode 100644 index 00000000..b101fa55 --- /dev/null +++ b/docs/search-core.searchservice.verticalsearch.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SearchService](./search-core.searchservice.md) > [verticalSearch](./search-core.searchservice.verticalsearch.md) + +## SearchService.verticalSearch() method + +Performs a search across a particular Vertical. + +Signature: + +```typescript +verticalSearch(request: VerticalSearchRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [VerticalSearchRequest](./search-core.verticalsearchrequest.md) | The details of the Vertical search request. | + +Returns: + +Promise<[VerticalSearchResponse](./search-core.verticalsearchresponse.md)> + diff --git a/docs/answers-core.snippet.matchedsubstrings.md b/docs/search-core.snippet.matchedsubstrings.md similarity index 53% rename from docs/answers-core.snippet.matchedsubstrings.md rename to docs/search-core.snippet.matchedsubstrings.md index dcb5e542..7a3945f9 100644 --- a/docs/answers-core.snippet.matchedsubstrings.md +++ b/docs/search-core.snippet.matchedsubstrings.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Snippet](./answers-core.snippet.md) > [matchedSubstrings](./answers-core.snippet.matchedsubstrings.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Snippet](./search-core.snippet.md) > [matchedSubstrings](./search-core.snippet.matchedsubstrings.md) ## Snippet.matchedSubstrings property -The locations in the document text of the [FeaturedSnippetDirectAnswer.value](./answers-core.featuredsnippetdirectanswer.value.md) +The locations in the document text of the [FeaturedSnippetDirectAnswer.value](./search-core.featuredsnippetdirectanswer.value.md) Signature: diff --git a/docs/search-core.snippet.md b/docs/search-core.snippet.md new file mode 100644 index 00000000..50692ffc --- /dev/null +++ b/docs/search-core.snippet.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Snippet](./search-core.snippet.md) + +## Snippet interface + +The section of text where a [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) was found. + +Signature: + +```typescript +export interface Snippet +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [matchedSubstrings](./search-core.snippet.matchedsubstrings.md) | { offset: number; length: number; }\[\] | The locations in the document text of the [FeaturedSnippetDirectAnswer.value](./search-core.featuredsnippetdirectanswer.value.md) | +| [value](./search-core.snippet.value.md) | string | The snippet's body of text | + diff --git a/docs/answers-core.snippet.value.md b/docs/search-core.snippet.value.md similarity index 53% rename from docs/answers-core.snippet.value.md rename to docs/search-core.snippet.value.md index 46107727..d061bf0c 100644 --- a/docs/answers-core.snippet.value.md +++ b/docs/search-core.snippet.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Snippet](./answers-core.snippet.md) > [value](./answers-core.snippet.value.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Snippet](./search-core.snippet.md) > [value](./search-core.snippet.value.md) ## Snippet.value property diff --git a/docs/answers-core.sortby.direction.md b/docs/search-core.sortby.direction.md similarity index 52% rename from docs/answers-core.sortby.direction.md rename to docs/search-core.sortby.direction.md index ece17b74..63fd04ee 100644 --- a/docs/answers-core.sortby.direction.md +++ b/docs/search-core.sortby.direction.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SortBy](./answers-core.sortby.md) > [direction](./answers-core.sortby.direction.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SortBy](./search-core.sortby.md) > [direction](./search-core.sortby.direction.md) ## SortBy.direction property -The direction of the sort. Required if the SortBy type is [SortType.Field](./answers-core.sorttype.md). +The direction of the sort. Required if the SortBy type is [SortType.Field](./search-core.sorttype.md). Signature: diff --git a/docs/answers-core.sortby.field.md b/docs/search-core.sortby.field.md similarity index 51% rename from docs/answers-core.sortby.field.md rename to docs/search-core.sortby.field.md index 03bfe790..26ca2785 100644 --- a/docs/answers-core.sortby.field.md +++ b/docs/search-core.sortby.field.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SortBy](./answers-core.sortby.md) > [field](./answers-core.sortby.field.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SortBy](./search-core.sortby.md) > [field](./search-core.sortby.field.md) ## SortBy.field property -The field name to sort by. Required if the SortBy type is [SortType.Field](./answers-core.sorttype.md). +The field name to sort by. Required if the SortBy type is [SortType.Field](./search-core.sorttype.md). Signature: diff --git a/docs/search-core.sortby.md b/docs/search-core.sortby.md new file mode 100644 index 00000000..6bf52e03 --- /dev/null +++ b/docs/search-core.sortby.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SortBy](./search-core.sortby.md) + +## SortBy interface + +Represents a criterion that can be used to sort results. + +Signature: + +```typescript +export interface SortBy +``` + +## Remarks + +Overrides the sort options that are configured on the experience configuration. + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [direction?](./search-core.sortby.direction.md) | [Direction](./search-core.direction.md) | (Optional) The direction of the sort. Required if the SortBy type is [SortType.Field](./search-core.sorttype.md). | +| [field?](./search-core.sortby.field.md) | string | (Optional) The field name to sort by. Required if the SortBy type is [SortType.Field](./search-core.sorttype.md). | +| [type](./search-core.sortby.type.md) | [SortType](./search-core.sorttype.md) | The method of sorting. | + diff --git a/docs/answers-core.sortby.type.md b/docs/search-core.sortby.type.md similarity index 53% rename from docs/answers-core.sortby.type.md rename to docs/search-core.sortby.type.md index 77a85a52..a0a05f94 100644 --- a/docs/answers-core.sortby.type.md +++ b/docs/search-core.sortby.type.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SortBy](./answers-core.sortby.md) > [type](./answers-core.sortby.type.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SortBy](./search-core.sortby.md) > [type](./search-core.sortby.type.md) ## SortBy.type property diff --git a/docs/answers-core.sorttype.md b/docs/search-core.sorttype.md similarity index 82% rename from docs/answers-core.sorttype.md rename to docs/search-core.sorttype.md index 3417287c..40999eba 100644 --- a/docs/answers-core.sorttype.md +++ b/docs/search-core.sorttype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SortType](./answers-core.sorttype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SortType](./search-core.sorttype.md) ## SortType enum diff --git a/docs/answers-core.source.md b/docs/search-core.source.md similarity index 74% rename from docs/answers-core.source.md rename to docs/search-core.source.md index 77f9c296..23a39cf7 100644 --- a/docs/answers-core.source.md +++ b/docs/search-core.source.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Source](./answers-core.source.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Source](./search-core.source.md) ## Source enum -Represents the source of a [Result](./answers-core.result.md). +Represents the source of a [Result](./search-core.result.md). Signature: @@ -20,6 +20,6 @@ export declare enum Source | Bing | "BING_CSE" | The result is from Bing Search Engine. | | Custom | "CUSTOM_SEARCHER" | The result was from a custom source. | | Google | "GOOGLE_CSE" | The result is from Google Custom Search Engine. | -| KnowledgeManager | "KNOWLEDGE_MANAGER" | The result is from an Answers Knowledge Graph. | +| KnowledgeManager | "KNOWLEDGE_MANAGER" | The result is from a Knowledge Graph. | | Zendesk | "ZENDESK" | The result is from Zendesk. | diff --git a/docs/answers-core.spellcheck.correctedquery.md b/docs/search-core.spellcheck.correctedquery.md similarity index 54% rename from docs/answers-core.spellcheck.correctedquery.md rename to docs/search-core.spellcheck.correctedquery.md index ff1b3f7f..69fba030 100644 --- a/docs/answers-core.spellcheck.correctedquery.md +++ b/docs/search-core.spellcheck.correctedquery.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SpellCheck](./answers-core.spellcheck.md) > [correctedQuery](./answers-core.spellcheck.correctedquery.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SpellCheck](./search-core.spellcheck.md) > [correctedQuery](./search-core.spellcheck.correctedquery.md) ## SpellCheck.correctedQuery property diff --git a/docs/search-core.spellcheck.md b/docs/search-core.spellcheck.md new file mode 100644 index 00000000..7774e1f1 --- /dev/null +++ b/docs/search-core.spellcheck.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SpellCheck](./search-core.spellcheck.md) + +## SpellCheck interface + +A spellcheck response from a search query. + +Signature: + +```typescript +export interface SpellCheck +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [correctedQuery](./search-core.spellcheck.correctedquery.md) | string | The corrected version of the originalQuery. | +| [originalQuery](./search-core.spellcheck.originalquery.md) | string | The query that was input into the spell checker. | +| [type](./search-core.spellcheck.type.md) | [SpellCheckType](./search-core.spellchecktype.md) | The type of spell check. | + diff --git a/docs/answers-core.spellcheck.originalquery.md b/docs/search-core.spellcheck.originalquery.md similarity index 54% rename from docs/answers-core.spellcheck.originalquery.md rename to docs/search-core.spellcheck.originalquery.md index b287a42e..d62d492f 100644 --- a/docs/answers-core.spellcheck.originalquery.md +++ b/docs/search-core.spellcheck.originalquery.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SpellCheck](./answers-core.spellcheck.md) > [originalQuery](./answers-core.spellcheck.originalquery.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SpellCheck](./search-core.spellcheck.md) > [originalQuery](./search-core.spellcheck.originalquery.md) ## SpellCheck.originalQuery property diff --git a/docs/answers-core.spellcheck.type.md b/docs/search-core.spellcheck.type.md similarity index 53% rename from docs/answers-core.spellcheck.type.md rename to docs/search-core.spellcheck.type.md index 5d30ff1e..baa38742 100644 --- a/docs/answers-core.spellcheck.type.md +++ b/docs/search-core.spellcheck.type.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SpellCheck](./answers-core.spellcheck.md) > [type](./answers-core.spellcheck.type.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SpellCheck](./search-core.spellcheck.md) > [type](./search-core.spellcheck.type.md) ## SpellCheck.type property diff --git a/docs/answers-core.spellchecktype.md b/docs/search-core.spellchecktype.md similarity index 81% rename from docs/answers-core.spellchecktype.md rename to docs/search-core.spellchecktype.md index b379a8a3..0eade1f8 100644 --- a/docs/answers-core.spellchecktype.md +++ b/docs/search-core.spellchecktype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [SpellCheckType](./answers-core.spellchecktype.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [SpellCheckType](./search-core.spellchecktype.md) ## SpellCheckType enum diff --git a/docs/search-core.universalautocompleterequest.input.md b/docs/search-core.universalautocompleterequest.input.md new file mode 100644 index 00000000..c6b39e8b --- /dev/null +++ b/docs/search-core.universalautocompleterequest.input.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalAutocompleteRequest](./search-core.universalautocompleterequest.md) > [input](./search-core.universalautocompleterequest.input.md) + +## UniversalAutocompleteRequest.input property + +The input string for autocomplete. + +Signature: + +```typescript +input: string; +``` diff --git a/docs/search-core.universalautocompleterequest.md b/docs/search-core.universalautocompleterequest.md new file mode 100644 index 00000000..15bb9d26 --- /dev/null +++ b/docs/search-core.universalautocompleterequest.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalAutocompleteRequest](./search-core.universalautocompleterequest.md) + +## UniversalAutocompleteRequest interface + +Options for a universal autocomplete request. + +Signature: + +```typescript +export interface UniversalAutocompleteRequest extends SearchRequest +``` +Extends: [SearchRequest](./search-core.searchrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [input](./search-core.universalautocompleterequest.input.md) | string | The input string for autocomplete. | +| [sessionTrackingEnabled?](./search-core.universalautocompleterequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | + diff --git a/docs/search-core.universalautocompleterequest.sessiontrackingenabled.md b/docs/search-core.universalautocompleterequest.sessiontrackingenabled.md new file mode 100644 index 00000000..78afcf72 --- /dev/null +++ b/docs/search-core.universalautocompleterequest.sessiontrackingenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalAutocompleteRequest](./search-core.universalautocompleterequest.md) > [sessionTrackingEnabled](./search-core.universalautocompleterequest.sessiontrackingenabled.md) + +## UniversalAutocompleteRequest.sessionTrackingEnabled property + +Enables session tracking. + +Signature: + +```typescript +sessionTrackingEnabled?: boolean; +``` diff --git a/docs/answers-core.universallimit.md b/docs/search-core.universallimit.md similarity index 70% rename from docs/answers-core.universallimit.md rename to docs/search-core.universallimit.md index 713e6901..7ffdb533 100644 --- a/docs/answers-core.universallimit.md +++ b/docs/search-core.universallimit.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalLimit](./answers-core.universallimit.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalLimit](./search-core.universallimit.md) ## UniversalLimit interface diff --git a/docs/search-core.universalsearchrequest.context.md b/docs/search-core.universalsearchrequest.context.md new file mode 100644 index 00000000..6797288e --- /dev/null +++ b/docs/search-core.universalsearchrequest.context.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) > [context](./search-core.universalsearchrequest.context.md) + +## UniversalSearchRequest.context property + +Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). + +Signature: + +```typescript +context?: Context; +``` + +## Remarks + +May be any valid JSON object + diff --git a/docs/answers-core.universalsearchrequest.limit.md b/docs/search-core.universalsearchrequest.limit.md similarity index 56% rename from docs/answers-core.universalsearchrequest.limit.md rename to docs/search-core.universalsearchrequest.limit.md index c24346f8..65f0575a 100644 --- a/docs/answers-core.universalsearchrequest.limit.md +++ b/docs/search-core.universalsearchrequest.limit.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) > [limit](./answers-core.universalsearchrequest.limit.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) > [limit](./search-core.universalsearchrequest.limit.md) ## UniversalSearchRequest.limit property diff --git a/docs/answers-core.universalsearchrequest.location.md b/docs/search-core.universalsearchrequest.location.md similarity index 61% rename from docs/answers-core.universalsearchrequest.location.md rename to docs/search-core.universalsearchrequest.location.md index b9c13c7a..a608fd41 100644 --- a/docs/answers-core.universalsearchrequest.location.md +++ b/docs/search-core.universalsearchrequest.location.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) > [location](./answers-core.universalsearchrequest.location.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) > [location](./search-core.universalsearchrequest.location.md) ## UniversalSearchRequest.location property diff --git a/docs/search-core.universalsearchrequest.md b/docs/search-core.universalsearchrequest.md new file mode 100644 index 00000000..d6d6b394 --- /dev/null +++ b/docs/search-core.universalsearchrequest.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) + +## UniversalSearchRequest interface + +Options which can be specified for a universal search. + +Signature: + +```typescript +export interface UniversalSearchRequest extends SearchRequest +``` +Extends: [SearchRequest](./search-core.searchrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [context?](./search-core.universalsearchrequest.context.md) | [Context](./search-core.context.md) | (Optional) Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | +| [limit?](./search-core.universalsearchrequest.limit.md) | [UniversalLimit](./search-core.universallimit.md) | (Optional) The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. | +| [location?](./search-core.universalsearchrequest.location.md) | [LatLong](./search-core.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | +| [query](./search-core.universalsearchrequest.query.md) | string | The search query. | +| [querySource?](./search-core.universalsearchrequest.querysource.md) | [QuerySource](./search-core.querysource.md) \| string | (Optional) The source of the search request. | +| [queryTrigger?](./search-core.universalsearchrequest.querytrigger.md) | [QueryTrigger](./search-core.querytrigger.md) | (Optional) Describes the ways a search can be executed besides user input. | +| [referrerPageUrl?](./search-core.universalsearchrequest.referrerpageurl.md) | string | (Optional) The URl of the page which referred the user to the current page. | +| [restrictVerticals?](./search-core.universalsearchrequest.restrictverticals.md) | string\[\] | (Optional) If included, the response will only include these verticals. | +| [sessionId?](./search-core.universalsearchrequest.sessionid.md) | string | (Optional) Used to track session state when cookies are blocked. | +| [sessionTrackingEnabled?](./search-core.universalsearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | +| [skipSpellCheck?](./search-core.universalsearchrequest.skipspellcheck.md) | boolean | (Optional) Disables spellcheck if true. | + diff --git a/docs/search-core.universalsearchrequest.query.md b/docs/search-core.universalsearchrequest.query.md new file mode 100644 index 00000000..bf6394a3 --- /dev/null +++ b/docs/search-core.universalsearchrequest.query.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) > [query](./search-core.universalsearchrequest.query.md) + +## UniversalSearchRequest.query property + +The search query. + +Signature: + +```typescript +query: string; +``` diff --git a/docs/answers-core.universalsearchrequest.querysource.md b/docs/search-core.universalsearchrequest.querysource.md similarity index 51% rename from docs/answers-core.universalsearchrequest.querysource.md rename to docs/search-core.universalsearchrequest.querysource.md index c77ae61a..9c04b595 100644 --- a/docs/answers-core.universalsearchrequest.querysource.md +++ b/docs/search-core.universalsearchrequest.querysource.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) > [querySource](./answers-core.universalsearchrequest.querysource.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) > [querySource](./search-core.universalsearchrequest.querysource.md) ## UniversalSearchRequest.querySource property diff --git a/docs/answers-core.universalsearchrequest.querytrigger.md b/docs/search-core.universalsearchrequest.querytrigger.md similarity index 61% rename from docs/answers-core.universalsearchrequest.querytrigger.md rename to docs/search-core.universalsearchrequest.querytrigger.md index 85f2cf51..61662b6c 100644 --- a/docs/answers-core.universalsearchrequest.querytrigger.md +++ b/docs/search-core.universalsearchrequest.querytrigger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) > [queryTrigger](./answers-core.universalsearchrequest.querytrigger.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) > [queryTrigger](./search-core.universalsearchrequest.querytrigger.md) ## UniversalSearchRequest.queryTrigger property diff --git a/docs/answers-core.universalsearchrequest.referrerpageurl.md b/docs/search-core.universalsearchrequest.referrerpageurl.md similarity index 64% rename from docs/answers-core.universalsearchrequest.referrerpageurl.md rename to docs/search-core.universalsearchrequest.referrerpageurl.md index 79446323..ae9428ee 100644 --- a/docs/answers-core.universalsearchrequest.referrerpageurl.md +++ b/docs/search-core.universalsearchrequest.referrerpageurl.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) > [referrerPageUrl](./answers-core.universalsearchrequest.referrerpageurl.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) > [referrerPageUrl](./search-core.universalsearchrequest.referrerpageurl.md) ## UniversalSearchRequest.referrerPageUrl property diff --git a/docs/answers-core.universalsearchrequest.restrictverticals.md b/docs/search-core.universalsearchrequest.restrictverticals.md similarity index 53% rename from docs/answers-core.universalsearchrequest.restrictverticals.md rename to docs/search-core.universalsearchrequest.restrictverticals.md index 78a57788..fe9f5c39 100644 --- a/docs/answers-core.universalsearchrequest.restrictverticals.md +++ b/docs/search-core.universalsearchrequest.restrictverticals.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) > [restrictVerticals](./answers-core.universalsearchrequest.restrictverticals.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) > [restrictVerticals](./search-core.universalsearchrequest.restrictverticals.md) ## UniversalSearchRequest.restrictVerticals property diff --git a/docs/answers-core.universalsearchrequest.sessionid.md b/docs/search-core.universalsearchrequest.sessionid.md similarity index 52% rename from docs/answers-core.universalsearchrequest.sessionid.md rename to docs/search-core.universalsearchrequest.sessionid.md index 1fadc76a..b2a0c177 100644 --- a/docs/answers-core.universalsearchrequest.sessionid.md +++ b/docs/search-core.universalsearchrequest.sessionid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchRequest](./answers-core.universalsearchrequest.md) > [sessionId](./answers-core.universalsearchrequest.sessionid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) > [sessionId](./search-core.universalsearchrequest.sessionid.md) ## UniversalSearchRequest.sessionId property diff --git a/docs/search-core.universalsearchrequest.sessiontrackingenabled.md b/docs/search-core.universalsearchrequest.sessiontrackingenabled.md new file mode 100644 index 00000000..6205f43e --- /dev/null +++ b/docs/search-core.universalsearchrequest.sessiontrackingenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) > [sessionTrackingEnabled](./search-core.universalsearchrequest.sessiontrackingenabled.md) + +## UniversalSearchRequest.sessionTrackingEnabled property + +Enables session tracking. + +Signature: + +```typescript +sessionTrackingEnabled?: boolean; +``` diff --git a/docs/search-core.universalsearchrequest.skipspellcheck.md b/docs/search-core.universalsearchrequest.skipspellcheck.md new file mode 100644 index 00000000..3c37dca9 --- /dev/null +++ b/docs/search-core.universalsearchrequest.skipspellcheck.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchRequest](./search-core.universalsearchrequest.md) > [skipSpellCheck](./search-core.universalsearchrequest.skipspellcheck.md) + +## UniversalSearchRequest.skipSpellCheck property + +Disables spellcheck if true. + +Signature: + +```typescript +skipSpellCheck?: boolean; +``` diff --git a/docs/answers-core.universalsearchresponse.directanswer.md b/docs/search-core.universalsearchresponse.directanswer.md similarity index 54% rename from docs/answers-core.universalsearchresponse.directanswer.md rename to docs/search-core.universalsearchresponse.directanswer.md index d7e17f9a..2a8a0a56 100644 --- a/docs/answers-core.universalsearchresponse.directanswer.md +++ b/docs/search-core.universalsearchresponse.directanswer.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchResponse](./answers-core.universalsearchresponse.md) > [directAnswer](./answers-core.universalsearchresponse.directanswer.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchResponse](./search-core.universalsearchresponse.md) > [directAnswer](./search-core.universalsearchresponse.directanswer.md) ## UniversalSearchResponse.directAnswer property diff --git a/docs/answers-core.universalsearchresponse.failedverticals.md b/docs/search-core.universalsearchresponse.failedverticals.md similarity index 54% rename from docs/answers-core.universalsearchresponse.failedverticals.md rename to docs/search-core.universalsearchresponse.failedverticals.md index f96e951d..b3f91ff7 100644 --- a/docs/answers-core.universalsearchresponse.failedverticals.md +++ b/docs/search-core.universalsearchresponse.failedverticals.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchResponse](./answers-core.universalsearchresponse.md) > [failedVerticals](./answers-core.universalsearchresponse.failedverticals.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchResponse](./search-core.universalsearchresponse.md) > [failedVerticals](./search-core.universalsearchresponse.failedverticals.md) ## UniversalSearchResponse.failedVerticals property diff --git a/docs/answers-core.universalsearchresponse.locationbias.md b/docs/search-core.universalsearchresponse.locationbias.md similarity index 51% rename from docs/answers-core.universalsearchresponse.locationbias.md rename to docs/search-core.universalsearchresponse.locationbias.md index 27ed0d35..bde42c3c 100644 --- a/docs/answers-core.universalsearchresponse.locationbias.md +++ b/docs/search-core.universalsearchresponse.locationbias.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchResponse](./answers-core.universalsearchresponse.md) > [locationBias](./answers-core.universalsearchresponse.locationbias.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchResponse](./search-core.universalsearchresponse.md) > [locationBias](./search-core.universalsearchresponse.locationbias.md) ## UniversalSearchResponse.locationBias property diff --git a/docs/search-core.universalsearchresponse.md b/docs/search-core.universalsearchresponse.md new file mode 100644 index 00000000..47df87db --- /dev/null +++ b/docs/search-core.universalsearchresponse.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchResponse](./search-core.universalsearchresponse.md) + +## UniversalSearchResponse interface + +A representation of a response from a universal search. + +Signature: + +```typescript +export interface UniversalSearchResponse +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [directAnswer?](./search-core.universalsearchresponse.directanswer.md) | [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) | (Optional) A direct answer to a search. | +| [failedVerticals?](./search-core.universalsearchresponse.failedverticals.md) | [FailedVertical](./search-core.failedvertical.md)\[\] | (Optional) Error information from when a vertical fails to return results. | +| [locationBias?](./search-core.universalsearchresponse.locationbias.md) | [LocationBias](./search-core.locationbias.md) | (Optional) Information about the user's location. | +| [queryId?](./search-core.universalsearchresponse.queryid.md) | string | (Optional) The ID of the search query. | +| [queryRulesActionsData?](./search-core.universalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./search-core.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Search query rules system. | +| [searchIntents?](./search-core.universalsearchresponse.searchintents.md) | [SearchIntent](./search-core.searchintent.md)\[\] | (Optional) An array of [SearchIntent](./search-core.searchintent.md)s which represents requests from the API. | +| [spellCheck?](./search-core.universalsearchresponse.spellcheck.md) | [SpellCheck](./search-core.spellcheck.md) | (Optional) A spellcheck response from a search query. | +| [uuid](./search-core.universalsearchresponse.uuid.md) | string | A unique id which corresponds to the request. | +| [verticalResults](./search-core.universalsearchresponse.verticalresults.md) | [VerticalResults](./search-core.verticalresults.md)\[\] | An array of [VerticalResults](./search-core.verticalresults.md) which represent the results for each vertical. | + diff --git a/docs/search-core.universalsearchresponse.queryid.md b/docs/search-core.universalsearchresponse.queryid.md new file mode 100644 index 00000000..7df8c8ee --- /dev/null +++ b/docs/search-core.universalsearchresponse.queryid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchResponse](./search-core.universalsearchresponse.md) > [queryId](./search-core.universalsearchresponse.queryid.md) + +## UniversalSearchResponse.queryId property + +The ID of the search query. + +Signature: + +```typescript +queryId?: string; +``` diff --git a/docs/search-core.universalsearchresponse.queryrulesactionsdata.md b/docs/search-core.universalsearchresponse.queryrulesactionsdata.md new file mode 100644 index 00000000..a3232c0b --- /dev/null +++ b/docs/search-core.universalsearchresponse.queryrulesactionsdata.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchResponse](./search-core.universalsearchresponse.md) > [queryRulesActionsData](./search-core.universalsearchresponse.queryrulesactionsdata.md) + +## UniversalSearchResponse.queryRulesActionsData property + +Data returned from the Search query rules system. + +Signature: + +```typescript +queryRulesActionsData?: QueryRulesActionsData[]; +``` diff --git a/docs/search-core.universalsearchresponse.searchintents.md b/docs/search-core.universalsearchresponse.searchintents.md new file mode 100644 index 00000000..ec1bbae3 --- /dev/null +++ b/docs/search-core.universalsearchresponse.searchintents.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchResponse](./search-core.universalsearchresponse.md) > [searchIntents](./search-core.universalsearchresponse.searchintents.md) + +## UniversalSearchResponse.searchIntents property + +An array of [SearchIntent](./search-core.searchintent.md)s which represents requests from the API. + +Signature: + +```typescript +searchIntents?: SearchIntent[]; +``` diff --git a/docs/answers-core.universalsearchresponse.spellcheck.md b/docs/search-core.universalsearchresponse.spellcheck.md similarity index 51% rename from docs/answers-core.universalsearchresponse.spellcheck.md rename to docs/search-core.universalsearchresponse.spellcheck.md index e4167f6d..735a90c5 100644 --- a/docs/answers-core.universalsearchresponse.spellcheck.md +++ b/docs/search-core.universalsearchresponse.spellcheck.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchResponse](./answers-core.universalsearchresponse.md) > [spellCheck](./answers-core.universalsearchresponse.spellcheck.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchResponse](./search-core.universalsearchresponse.md) > [spellCheck](./search-core.universalsearchresponse.spellcheck.md) ## UniversalSearchResponse.spellCheck property diff --git a/docs/answers-core.universalsearchresponse.uuid.md b/docs/search-core.universalsearchresponse.uuid.md similarity index 51% rename from docs/answers-core.universalsearchresponse.uuid.md rename to docs/search-core.universalsearchresponse.uuid.md index 8d75318a..0540b1db 100644 --- a/docs/answers-core.universalsearchresponse.uuid.md +++ b/docs/search-core.universalsearchresponse.uuid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [UniversalSearchResponse](./answers-core.universalsearchresponse.md) > [uuid](./answers-core.universalsearchresponse.uuid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchResponse](./search-core.universalsearchresponse.md) > [uuid](./search-core.universalsearchresponse.uuid.md) ## UniversalSearchResponse.uuid property diff --git a/docs/search-core.universalsearchresponse.verticalresults.md b/docs/search-core.universalsearchresponse.verticalresults.md new file mode 100644 index 00000000..7f202d09 --- /dev/null +++ b/docs/search-core.universalsearchresponse.verticalresults.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UniversalSearchResponse](./search-core.universalsearchresponse.md) > [verticalResults](./search-core.universalsearchresponse.verticalresults.md) + +## UniversalSearchResponse.verticalResults property + +An array of [VerticalResults](./search-core.verticalresults.md) which represent the results for each vertical. + +Signature: + +```typescript +verticalResults: VerticalResults[]; +``` diff --git a/docs/search-core.uppernumberrangelimit.matcher.md b/docs/search-core.uppernumberrangelimit.matcher.md new file mode 100644 index 00000000..36266ea5 --- /dev/null +++ b/docs/search-core.uppernumberrangelimit.matcher.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UpperNumberRangeLimit](./search-core.uppernumberrangelimit.md) > [matcher](./search-core.uppernumberrangelimit.matcher.md) + +## UpperNumberRangeLimit.matcher property + +[Matcher](./search-core.matcher.md) for the end limit + +Signature: + +```typescript +matcher: Matcher.LessThan | Matcher.LessThanOrEqualTo; +``` diff --git a/docs/search-core.uppernumberrangelimit.md b/docs/search-core.uppernumberrangelimit.md new file mode 100644 index 00000000..38a732f4 --- /dev/null +++ b/docs/search-core.uppernumberrangelimit.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UpperNumberRangeLimit](./search-core.uppernumberrangelimit.md) + +## UpperNumberRangeLimit interface + +The end limit of [NumberRangeValue](./search-core.numberrangevalue.md). + +Signature: + +```typescript +export interface UpperNumberRangeLimit +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [matcher](./search-core.uppernumberrangelimit.matcher.md) | [Matcher.LessThan](./search-core.matcher.md) \| [Matcher.LessThanOrEqualTo](./search-core.matcher.md) | [Matcher](./search-core.matcher.md) for the end limit | +| [value](./search-core.uppernumberrangelimit.value.md) | number | Value of the limit. | + diff --git a/docs/search-core.uppernumberrangelimit.value.md b/docs/search-core.uppernumberrangelimit.value.md new file mode 100644 index 00000000..3d5d6897 --- /dev/null +++ b/docs/search-core.uppernumberrangelimit.value.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [UpperNumberRangeLimit](./search-core.uppernumberrangelimit.md) > [value](./search-core.uppernumberrangelimit.value.md) + +## UpperNumberRangeLimit.value property + +Value of the limit. + +Signature: + +```typescript +value: number; +``` diff --git a/docs/search-core.verticalautocompleterequest.input.md b/docs/search-core.verticalautocompleterequest.input.md new file mode 100644 index 00000000..386252c7 --- /dev/null +++ b/docs/search-core.verticalautocompleterequest.input.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalAutocompleteRequest](./search-core.verticalautocompleterequest.md) > [input](./search-core.verticalautocompleterequest.input.md) + +## VerticalAutocompleteRequest.input property + +The input string for autocomplete. + +Signature: + +```typescript +input: string; +``` diff --git a/docs/search-core.verticalautocompleterequest.md b/docs/search-core.verticalautocompleterequest.md new file mode 100644 index 00000000..6b26141d --- /dev/null +++ b/docs/search-core.verticalautocompleterequest.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalAutocompleteRequest](./search-core.verticalautocompleterequest.md) + +## VerticalAutocompleteRequest interface + +Options for a vertial autocomplete request. + +Signature: + +```typescript +export interface VerticalAutocompleteRequest extends SearchRequest +``` +Extends: [SearchRequest](./search-core.searchrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [input](./search-core.verticalautocompleterequest.input.md) | string | The input string for autocomplete. | +| [sessionTrackingEnabled?](./search-core.verticalautocompleterequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | +| [verticalKey](./search-core.verticalautocompleterequest.verticalkey.md) | string | The key for the vertical to get autocomplete suggestions from. | + diff --git a/docs/search-core.verticalautocompleterequest.sessiontrackingenabled.md b/docs/search-core.verticalautocompleterequest.sessiontrackingenabled.md new file mode 100644 index 00000000..b635daef --- /dev/null +++ b/docs/search-core.verticalautocompleterequest.sessiontrackingenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalAutocompleteRequest](./search-core.verticalautocompleterequest.md) > [sessionTrackingEnabled](./search-core.verticalautocompleterequest.sessiontrackingenabled.md) + +## VerticalAutocompleteRequest.sessionTrackingEnabled property + +Enables session tracking. + +Signature: + +```typescript +sessionTrackingEnabled?: boolean; +``` diff --git a/docs/answers-core.verticalautocompleterequest.verticalkey.md b/docs/search-core.verticalautocompleterequest.verticalkey.md similarity index 52% rename from docs/answers-core.verticalautocompleterequest.verticalkey.md rename to docs/search-core.verticalautocompleterequest.verticalkey.md index b71c4434..3c3b59d0 100644 --- a/docs/answers-core.verticalautocompleterequest.verticalkey.md +++ b/docs/search-core.verticalautocompleterequest.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalAutocompleteRequest](./answers-core.verticalautocompleterequest.md) > [verticalKey](./answers-core.verticalautocompleterequest.verticalkey.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalAutocompleteRequest](./search-core.verticalautocompleterequest.md) > [verticalKey](./search-core.verticalautocompleterequest.verticalkey.md) ## VerticalAutocompleteRequest.verticalKey property diff --git a/docs/search-core.verticalresults.appliedqueryfilters.md b/docs/search-core.verticalresults.appliedqueryfilters.md new file mode 100644 index 00000000..b71af36a --- /dev/null +++ b/docs/search-core.verticalresults.appliedqueryfilters.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalResults](./search-core.verticalresults.md) > [appliedQueryFilters](./search-core.verticalresults.appliedqueryfilters.md) + +## VerticalResults.appliedQueryFilters property + +A array of [AppliedQueryFilter](./search-core.appliedqueryfilter.md)s which were applied to the vertical results. + +Signature: + +```typescript +appliedQueryFilters: AppliedQueryFilter[]; +``` diff --git a/docs/search-core.verticalresults.md b/docs/search-core.verticalresults.md new file mode 100644 index 00000000..52cd94c7 --- /dev/null +++ b/docs/search-core.verticalresults.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalResults](./search-core.verticalresults.md) + +## VerticalResults interface + +Represents results from a search vertical. + +Signature: + +```typescript +export interface VerticalResults +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [appliedQueryFilters](./search-core.verticalresults.appliedqueryfilters.md) | [AppliedQueryFilter](./search-core.appliedqueryfilter.md)\[\] | A array of [AppliedQueryFilter](./search-core.appliedqueryfilter.md)s which were applied to the vertical results. | +| [queryDurationMillis](./search-core.verticalresults.querydurationmillis.md) | number | The duration of the query in milliseconds. | +| [results](./search-core.verticalresults.results.md) | [Result](./search-core.result.md)\[\] | An array of search [Result](./search-core.result.md)s for the vertical. | +| [resultsCount](./search-core.verticalresults.resultscount.md) | number | The total number of results within the vertical. | +| [source](./search-core.verticalresults.source.md) | [Source](./search-core.source.md) | Represents the source of a [Result](./search-core.result.md). | +| [verticalKey](./search-core.verticalresults.verticalkey.md) | string | The vertical key associated with the vertical results. | + diff --git a/docs/answers-core.verticalresults.querydurationmillis.md b/docs/search-core.verticalresults.querydurationmillis.md similarity index 52% rename from docs/answers-core.verticalresults.querydurationmillis.md rename to docs/search-core.verticalresults.querydurationmillis.md index f55a0e70..d170ce82 100644 --- a/docs/answers-core.verticalresults.querydurationmillis.md +++ b/docs/search-core.verticalresults.querydurationmillis.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalResults](./answers-core.verticalresults.md) > [queryDurationMillis](./answers-core.verticalresults.querydurationmillis.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalResults](./search-core.verticalresults.md) > [queryDurationMillis](./search-core.verticalresults.querydurationmillis.md) ## VerticalResults.queryDurationMillis property diff --git a/docs/search-core.verticalresults.results.md b/docs/search-core.verticalresults.results.md new file mode 100644 index 00000000..e5aee062 --- /dev/null +++ b/docs/search-core.verticalresults.results.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalResults](./search-core.verticalresults.md) > [results](./search-core.verticalresults.results.md) + +## VerticalResults.results property + +An array of search [Result](./search-core.result.md)s for the vertical. + +Signature: + +```typescript +results: Result[]; +``` diff --git a/docs/answers-core.verticalresults.resultscount.md b/docs/search-core.verticalresults.resultscount.md similarity index 65% rename from docs/answers-core.verticalresults.resultscount.md rename to docs/search-core.verticalresults.resultscount.md index 61a6bb82..fe8ab90f 100644 --- a/docs/answers-core.verticalresults.resultscount.md +++ b/docs/search-core.verticalresults.resultscount.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalResults](./answers-core.verticalresults.md) > [resultsCount](./answers-core.verticalresults.resultscount.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalResults](./search-core.verticalresults.md) > [resultsCount](./search-core.verticalresults.resultscount.md) ## VerticalResults.resultsCount property diff --git a/docs/search-core.verticalresults.source.md b/docs/search-core.verticalresults.source.md new file mode 100644 index 00000000..74bcc013 --- /dev/null +++ b/docs/search-core.verticalresults.source.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalResults](./search-core.verticalresults.md) > [source](./search-core.verticalresults.source.md) + +## VerticalResults.source property + +Represents the source of a [Result](./search-core.result.md). + +Signature: + +```typescript +source: Source; +``` diff --git a/docs/answers-core.verticalresults.verticalkey.md b/docs/search-core.verticalresults.verticalkey.md similarity index 54% rename from docs/answers-core.verticalresults.verticalkey.md rename to docs/search-core.verticalresults.verticalkey.md index c5b01584..2438d3be 100644 --- a/docs/answers-core.verticalresults.verticalkey.md +++ b/docs/search-core.verticalresults.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalResults](./answers-core.verticalresults.md) > [verticalKey](./answers-core.verticalresults.verticalkey.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalResults](./search-core.verticalresults.md) > [verticalKey](./search-core.verticalresults.verticalkey.md) ## VerticalResults.verticalKey property diff --git a/docs/search-core.verticalsearchrequest.context.md b/docs/search-core.verticalsearchrequest.context.md new file mode 100644 index 00000000..a23c24b8 --- /dev/null +++ b/docs/search-core.verticalsearchrequest.context.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [context](./search-core.verticalsearchrequest.context.md) + +## VerticalSearchRequest.context property + +Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). + +Signature: + +```typescript +context?: Context; +``` + +## Remarks + +May be any valid JSON object + diff --git a/docs/answers-core.verticalsearchrequest.facets.md b/docs/search-core.verticalsearchrequest.facets.md similarity index 51% rename from docs/answers-core.verticalsearchrequest.facets.md rename to docs/search-core.verticalsearchrequest.facets.md index a9b2a216..23c5f946 100644 --- a/docs/answers-core.verticalsearchrequest.facets.md +++ b/docs/search-core.verticalsearchrequest.facets.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [facets](./answers-core.verticalsearchrequest.facets.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [facets](./search-core.verticalsearchrequest.facets.md) ## VerticalSearchRequest.facets property diff --git a/docs/answers-core.verticalsearchrequest.limit.md b/docs/search-core.verticalsearchrequest.limit.md similarity index 53% rename from docs/answers-core.verticalsearchrequest.limit.md rename to docs/search-core.verticalsearchrequest.limit.md index b9933cf3..e3b30f9a 100644 --- a/docs/answers-core.verticalsearchrequest.limit.md +++ b/docs/search-core.verticalsearchrequest.limit.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [limit](./answers-core.verticalsearchrequest.limit.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [limit](./search-core.verticalsearchrequest.limit.md) ## VerticalSearchRequest.limit property diff --git a/docs/answers-core.verticalsearchrequest.location.md b/docs/search-core.verticalsearchrequest.location.md similarity index 62% rename from docs/answers-core.verticalsearchrequest.location.md rename to docs/search-core.verticalsearchrequest.location.md index ce6f8ae9..609e6b9f 100644 --- a/docs/answers-core.verticalsearchrequest.location.md +++ b/docs/search-core.verticalsearchrequest.location.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [location](./answers-core.verticalsearchrequest.location.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [location](./search-core.verticalsearchrequest.location.md) ## VerticalSearchRequest.location property diff --git a/docs/answers-core.verticalsearchrequest.locationradius.md b/docs/search-core.verticalsearchrequest.locationradius.md similarity index 52% rename from docs/answers-core.verticalsearchrequest.locationradius.md rename to docs/search-core.verticalsearchrequest.locationradius.md index 91175124..7f73c67c 100644 --- a/docs/answers-core.verticalsearchrequest.locationradius.md +++ b/docs/search-core.verticalsearchrequest.locationradius.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [locationRadius](./answers-core.verticalsearchrequest.locationradius.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [locationRadius](./search-core.verticalsearchrequest.locationradius.md) ## VerticalSearchRequest.locationRadius property diff --git a/docs/search-core.verticalsearchrequest.md b/docs/search-core.verticalsearchrequest.md new file mode 100644 index 00000000..5a7d6959 --- /dev/null +++ b/docs/search-core.verticalsearchrequest.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) + +## VerticalSearchRequest interface + +Options which can be specified for a vertical search. + +Signature: + +```typescript +export interface VerticalSearchRequest extends SearchRequest +``` +Extends: [SearchRequest](./search-core.searchrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [context?](./search-core.verticalsearchrequest.context.md) | [Context](./search-core.context.md) | (Optional) Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | +| [facets?](./search-core.verticalsearchrequest.facets.md) | [Facet](./search-core.facet.md)\[\] | (Optional) The facet filters to apply to the search. | +| [limit?](./search-core.verticalsearchrequest.limit.md) | number | (Optional) The maximum number of results to include with a max of 50. | +| [location?](./search-core.verticalsearchrequest.location.md) | [LatLong](./search-core.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | +| [locationRadius?](./search-core.verticalsearchrequest.locationradius.md) | number | (Optional) The radius (in meters) to filter the vertical search by. | +| [offset?](./search-core.verticalsearchrequest.offset.md) | number | (Optional) The result offset which allows for fetching more results with the same query. | +| [query](./search-core.verticalsearchrequest.query.md) | string | The search query. | +| [queryId?](./search-core.verticalsearchrequest.queryid.md) | string | (Optional) The queryId for the query, if this is a repeat query. | +| [querySource?](./search-core.verticalsearchrequest.querysource.md) | [QuerySource](./search-core.querysource.md) \| string | (Optional) The source of the search request. | +| [queryTrigger?](./search-core.verticalsearchrequest.querytrigger.md) | [QueryTrigger](./search-core.querytrigger.md) | (Optional) Describes the ways a search can be executed besides user input. | +| [referrerPageUrl?](./search-core.verticalsearchrequest.referrerpageurl.md) | string | (Optional) The URl of the page which referred the user to the current page. | +| [retrieveFacets?](./search-core.verticalsearchrequest.retrievefacets.md) | boolean | (Optional) Indicates that facets should be retrieved. | +| [sessionId?](./search-core.verticalsearchrequest.sessionid.md) | string | (Optional) Used to track session state when cookies are blocked. | +| [sessionTrackingEnabled?](./search-core.verticalsearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | +| [skipSpellCheck?](./search-core.verticalsearchrequest.skipspellcheck.md) | boolean | (Optional) Skips spell checking if true. | +| [sortBys?](./search-core.verticalsearchrequest.sortbys.md) | [SortBy](./search-core.sortby.md)\[\] | (Optional) Determines how results are sorted. \* | +| [staticFilters?](./search-core.verticalsearchrequest.staticfilters.md) | [CombinedFilter](./search-core.combinedfilter.md) \| [Filter](./search-core.filter.md) | (Optional) The static filters to apply to the search. | +| [verticalKey](./search-core.verticalsearchrequest.verticalkey.md) | string | The key associated with the vertical. | + diff --git a/docs/answers-core.verticalsearchrequest.offset.md b/docs/search-core.verticalsearchrequest.offset.md similarity index 55% rename from docs/answers-core.verticalsearchrequest.offset.md rename to docs/search-core.verticalsearchrequest.offset.md index 92c9e406..fc1daeb4 100644 --- a/docs/answers-core.verticalsearchrequest.offset.md +++ b/docs/search-core.verticalsearchrequest.offset.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [offset](./answers-core.verticalsearchrequest.offset.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [offset](./search-core.verticalsearchrequest.offset.md) ## VerticalSearchRequest.offset property diff --git a/docs/search-core.verticalsearchrequest.query.md b/docs/search-core.verticalsearchrequest.query.md new file mode 100644 index 00000000..47199973 --- /dev/null +++ b/docs/search-core.verticalsearchrequest.query.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [query](./search-core.verticalsearchrequest.query.md) + +## VerticalSearchRequest.query property + +The search query. + +Signature: + +```typescript +query: string; +``` diff --git a/docs/answers-core.verticalsearchrequest.queryid.md b/docs/search-core.verticalsearchrequest.queryid.md similarity index 52% rename from docs/answers-core.verticalsearchrequest.queryid.md rename to docs/search-core.verticalsearchrequest.queryid.md index ab5e6ad9..3e22ca84 100644 --- a/docs/answers-core.verticalsearchrequest.queryid.md +++ b/docs/search-core.verticalsearchrequest.queryid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [queryId](./answers-core.verticalsearchrequest.queryid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [queryId](./search-core.verticalsearchrequest.queryid.md) ## VerticalSearchRequest.queryId property diff --git a/docs/answers-core.verticalsearchrequest.querysource.md b/docs/search-core.verticalsearchrequest.querysource.md similarity index 52% rename from docs/answers-core.verticalsearchrequest.querysource.md rename to docs/search-core.verticalsearchrequest.querysource.md index 7700b6b3..6ca7b95a 100644 --- a/docs/answers-core.verticalsearchrequest.querysource.md +++ b/docs/search-core.verticalsearchrequest.querysource.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [querySource](./answers-core.verticalsearchrequest.querysource.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [querySource](./search-core.verticalsearchrequest.querysource.md) ## VerticalSearchRequest.querySource property diff --git a/docs/answers-core.verticalsearchrequest.querytrigger.md b/docs/search-core.verticalsearchrequest.querytrigger.md similarity index 62% rename from docs/answers-core.verticalsearchrequest.querytrigger.md rename to docs/search-core.verticalsearchrequest.querytrigger.md index 6cad4c37..d7cd57ff 100644 --- a/docs/answers-core.verticalsearchrequest.querytrigger.md +++ b/docs/search-core.verticalsearchrequest.querytrigger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [queryTrigger](./answers-core.verticalsearchrequest.querytrigger.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [queryTrigger](./search-core.verticalsearchrequest.querytrigger.md) ## VerticalSearchRequest.queryTrigger property diff --git a/docs/answers-core.verticalsearchrequest.referrerpageurl.md b/docs/search-core.verticalsearchrequest.referrerpageurl.md similarity index 53% rename from docs/answers-core.verticalsearchrequest.referrerpageurl.md rename to docs/search-core.verticalsearchrequest.referrerpageurl.md index e3092271..9828ff3f 100644 --- a/docs/answers-core.verticalsearchrequest.referrerpageurl.md +++ b/docs/search-core.verticalsearchrequest.referrerpageurl.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [referrerPageUrl](./answers-core.verticalsearchrequest.referrerpageurl.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [referrerPageUrl](./search-core.verticalsearchrequest.referrerpageurl.md) ## VerticalSearchRequest.referrerPageUrl property diff --git a/docs/answers-core.verticalsearchrequest.retrievefacets.md b/docs/search-core.verticalsearchrequest.retrievefacets.md similarity index 51% rename from docs/answers-core.verticalsearchrequest.retrievefacets.md rename to docs/search-core.verticalsearchrequest.retrievefacets.md index cb11c1c8..c9d15d18 100644 --- a/docs/answers-core.verticalsearchrequest.retrievefacets.md +++ b/docs/search-core.verticalsearchrequest.retrievefacets.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [retrieveFacets](./answers-core.verticalsearchrequest.retrievefacets.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [retrieveFacets](./search-core.verticalsearchrequest.retrievefacets.md) ## VerticalSearchRequest.retrieveFacets property diff --git a/docs/answers-core.verticalsearchrequest.sessionid.md b/docs/search-core.verticalsearchrequest.sessionid.md similarity index 52% rename from docs/answers-core.verticalsearchrequest.sessionid.md rename to docs/search-core.verticalsearchrequest.sessionid.md index c68c032c..ee8bdea9 100644 --- a/docs/answers-core.verticalsearchrequest.sessionid.md +++ b/docs/search-core.verticalsearchrequest.sessionid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [sessionId](./answers-core.verticalsearchrequest.sessionid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [sessionId](./search-core.verticalsearchrequest.sessionid.md) ## VerticalSearchRequest.sessionId property diff --git a/docs/search-core.verticalsearchrequest.sessiontrackingenabled.md b/docs/search-core.verticalsearchrequest.sessiontrackingenabled.md new file mode 100644 index 00000000..f467153b --- /dev/null +++ b/docs/search-core.verticalsearchrequest.sessiontrackingenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [sessionTrackingEnabled](./search-core.verticalsearchrequest.sessiontrackingenabled.md) + +## VerticalSearchRequest.sessionTrackingEnabled property + +Enables session tracking. + +Signature: + +```typescript +sessionTrackingEnabled?: boolean; +``` diff --git a/docs/answers-core.verticalsearchrequest.skipspellcheck.md b/docs/search-core.verticalsearchrequest.skipspellcheck.md similarity index 50% rename from docs/answers-core.verticalsearchrequest.skipspellcheck.md rename to docs/search-core.verticalsearchrequest.skipspellcheck.md index 8d1f7344..33398dc8 100644 --- a/docs/answers-core.verticalsearchrequest.skipspellcheck.md +++ b/docs/search-core.verticalsearchrequest.skipspellcheck.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [skipSpellCheck](./answers-core.verticalsearchrequest.skipspellcheck.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [skipSpellCheck](./search-core.verticalsearchrequest.skipspellcheck.md) ## VerticalSearchRequest.skipSpellCheck property diff --git a/docs/answers-core.verticalsearchrequest.sortbys.md b/docs/search-core.verticalsearchrequest.sortbys.md similarity index 51% rename from docs/answers-core.verticalsearchrequest.sortbys.md rename to docs/search-core.verticalsearchrequest.sortbys.md index 7c8f9e53..f3197853 100644 --- a/docs/answers-core.verticalsearchrequest.sortbys.md +++ b/docs/search-core.verticalsearchrequest.sortbys.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [sortBys](./answers-core.verticalsearchrequest.sortbys.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [sortBys](./search-core.verticalsearchrequest.sortbys.md) ## VerticalSearchRequest.sortBys property diff --git a/docs/answers-core.verticalsearchrequest.staticfilters.md b/docs/search-core.verticalsearchrequest.staticfilters.md similarity index 53% rename from docs/answers-core.verticalsearchrequest.staticfilters.md rename to docs/search-core.verticalsearchrequest.staticfilters.md index 18516b5f..4d42211f 100644 --- a/docs/answers-core.verticalsearchrequest.staticfilters.md +++ b/docs/search-core.verticalsearchrequest.staticfilters.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [staticFilters](./answers-core.verticalsearchrequest.staticfilters.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [staticFilters](./search-core.verticalsearchrequest.staticfilters.md) ## VerticalSearchRequest.staticFilters property diff --git a/docs/answers-core.verticalsearchrequest.verticalkey.md b/docs/search-core.verticalsearchrequest.verticalkey.md similarity index 50% rename from docs/answers-core.verticalsearchrequest.verticalkey.md rename to docs/search-core.verticalsearchrequest.verticalkey.md index 78b18f82..61d4fc7f 100644 --- a/docs/answers-core.verticalsearchrequest.verticalkey.md +++ b/docs/search-core.verticalsearchrequest.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchRequest](./answers-core.verticalsearchrequest.md) > [verticalKey](./answers-core.verticalsearchrequest.verticalkey.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchRequest](./search-core.verticalsearchrequest.md) > [verticalKey](./search-core.verticalsearchrequest.verticalkey.md) ## VerticalSearchRequest.verticalKey property diff --git a/docs/answers-core.verticalsearchresponse.allresultsforvertical.md b/docs/search-core.verticalsearchresponse.allresultsforvertical.md similarity index 53% rename from docs/answers-core.verticalsearchresponse.allresultsforvertical.md rename to docs/search-core.verticalsearchresponse.allresultsforvertical.md index 74c4abe6..6fe14bd7 100644 --- a/docs/answers-core.verticalsearchresponse.allresultsforvertical.md +++ b/docs/search-core.verticalsearchresponse.allresultsforvertical.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) > [allResultsForVertical](./answers-core.verticalsearchresponse.allresultsforvertical.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) > [allResultsForVertical](./search-core.verticalsearchresponse.allresultsforvertical.md) ## VerticalSearchResponse.allResultsForVertical property diff --git a/docs/search-core.verticalsearchresponse.alternativeverticals.md b/docs/search-core.verticalsearchresponse.alternativeverticals.md new file mode 100644 index 00000000..9e391226 --- /dev/null +++ b/docs/search-core.verticalsearchresponse.alternativeverticals.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) > [alternativeVerticals](./search-core.verticalsearchresponse.alternativeverticals.md) + +## VerticalSearchResponse.alternativeVerticals property + +The [VerticalResults](./search-core.verticalresults.md) for each search vertical. + +Signature: + +```typescript +alternativeVerticals?: VerticalResults[]; +``` diff --git a/docs/answers-core.verticalsearchresponse.directanswer.md b/docs/search-core.verticalsearchresponse.directanswer.md similarity index 54% rename from docs/answers-core.verticalsearchresponse.directanswer.md rename to docs/search-core.verticalsearchresponse.directanswer.md index f69c2dfd..a64fd350 100644 --- a/docs/answers-core.verticalsearchresponse.directanswer.md +++ b/docs/search-core.verticalsearchresponse.directanswer.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) > [directAnswer](./answers-core.verticalsearchresponse.directanswer.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) > [directAnswer](./search-core.verticalsearchresponse.directanswer.md) ## VerticalSearchResponse.directAnswer property diff --git a/docs/search-core.verticalsearchresponse.facets.md b/docs/search-core.verticalsearchresponse.facets.md new file mode 100644 index 00000000..4102a2ee --- /dev/null +++ b/docs/search-core.verticalsearchresponse.facets.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) > [facets](./search-core.verticalsearchresponse.facets.md) + +## VerticalSearchResponse.facets property + +An array of [Facet](./search-core.facet.md)s associated with the search results. + +Signature: + +```typescript +facets?: DisplayableFacet[]; +``` diff --git a/docs/answers-core.verticalsearchresponse.locationbias.md b/docs/search-core.verticalsearchresponse.locationbias.md similarity index 51% rename from docs/answers-core.verticalsearchresponse.locationbias.md rename to docs/search-core.verticalsearchresponse.locationbias.md index e541a991..256b5122 100644 --- a/docs/answers-core.verticalsearchresponse.locationbias.md +++ b/docs/search-core.verticalsearchresponse.locationbias.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) > [locationBias](./answers-core.verticalsearchresponse.locationbias.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) > [locationBias](./search-core.verticalsearchresponse.locationbias.md) ## VerticalSearchResponse.locationBias property diff --git a/docs/search-core.verticalsearchresponse.md b/docs/search-core.verticalsearchresponse.md new file mode 100644 index 00000000..2618213f --- /dev/null +++ b/docs/search-core.verticalsearchresponse.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) + +## VerticalSearchResponse interface + +A representation of a response from a vertical search. + +Signature: + +```typescript +export interface VerticalSearchResponse +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [allResultsForVertical?](./search-core.verticalsearchresponse.allresultsforvertical.md) | [VerticalSearchResponse](./search-core.verticalsearchresponse.md) | (Optional) A representation of a response from a vertical search. | +| [alternativeVerticals?](./search-core.verticalsearchresponse.alternativeverticals.md) | [VerticalResults](./search-core.verticalresults.md)\[\] | (Optional) The [VerticalResults](./search-core.verticalresults.md) for each search vertical. | +| [directAnswer?](./search-core.verticalsearchresponse.directanswer.md) | [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) | (Optional) A direct answer to a search. | +| [facets?](./search-core.verticalsearchresponse.facets.md) | [DisplayableFacet](./search-core.displayablefacet.md)\[\] | (Optional) An array of [Facet](./search-core.facet.md)s associated with the search results. | +| [locationBias?](./search-core.verticalsearchresponse.locationbias.md) | [LocationBias](./search-core.locationbias.md) | (Optional) Information about the user's location. | +| [queryId](./search-core.verticalsearchresponse.queryid.md) | string | The ID of the query. | +| [queryRulesActionsData?](./search-core.verticalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./search-core.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Search query rules system. | +| [searchIntents?](./search-core.verticalsearchresponse.searchintents.md) | [SearchIntent](./search-core.searchintent.md)\[\] | (Optional) An array of [SearchIntent](./search-core.searchintent.md)s. | +| [spellCheck?](./search-core.verticalsearchresponse.spellcheck.md) | [SpellCheck](./search-core.spellcheck.md) | (Optional) A spellcheck response from a search query. | +| [uuid](./search-core.verticalsearchresponse.uuid.md) | string | A unique id which corresponds to the request. | +| [verticalResults](./search-core.verticalsearchresponse.verticalresults.md) | [VerticalResults](./search-core.verticalresults.md) | Represents results from a search vertical. | + diff --git a/docs/search-core.verticalsearchresponse.queryid.md b/docs/search-core.verticalsearchresponse.queryid.md new file mode 100644 index 00000000..685b7f56 --- /dev/null +++ b/docs/search-core.verticalsearchresponse.queryid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) > [queryId](./search-core.verticalsearchresponse.queryid.md) + +## VerticalSearchResponse.queryId property + +The ID of the query. + +Signature: + +```typescript +queryId: string; +``` diff --git a/docs/search-core.verticalsearchresponse.queryrulesactionsdata.md b/docs/search-core.verticalsearchresponse.queryrulesactionsdata.md new file mode 100644 index 00000000..7b14ecb1 --- /dev/null +++ b/docs/search-core.verticalsearchresponse.queryrulesactionsdata.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) > [queryRulesActionsData](./search-core.verticalsearchresponse.queryrulesactionsdata.md) + +## VerticalSearchResponse.queryRulesActionsData property + +Data returned from the Search query rules system. + +Signature: + +```typescript +queryRulesActionsData?: QueryRulesActionsData[]; +``` diff --git a/docs/search-core.verticalsearchresponse.searchintents.md b/docs/search-core.verticalsearchresponse.searchintents.md new file mode 100644 index 00000000..36fb9721 --- /dev/null +++ b/docs/search-core.verticalsearchresponse.searchintents.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) > [searchIntents](./search-core.verticalsearchresponse.searchintents.md) + +## VerticalSearchResponse.searchIntents property + +An array of [SearchIntent](./search-core.searchintent.md)s. + +Signature: + +```typescript +searchIntents?: SearchIntent[]; +``` diff --git a/docs/answers-core.verticalsearchresponse.spellcheck.md b/docs/search-core.verticalsearchresponse.spellcheck.md similarity index 51% rename from docs/answers-core.verticalsearchresponse.spellcheck.md rename to docs/search-core.verticalsearchresponse.spellcheck.md index c1178737..5130ae0a 100644 --- a/docs/answers-core.verticalsearchresponse.spellcheck.md +++ b/docs/search-core.verticalsearchresponse.spellcheck.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) > [spellCheck](./answers-core.verticalsearchresponse.spellcheck.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) > [spellCheck](./search-core.verticalsearchresponse.spellcheck.md) ## VerticalSearchResponse.spellCheck property diff --git a/docs/answers-core.verticalsearchresponse.uuid.md b/docs/search-core.verticalsearchresponse.uuid.md similarity index 51% rename from docs/answers-core.verticalsearchresponse.uuid.md rename to docs/search-core.verticalsearchresponse.uuid.md index 9be574f5..cd3a4676 100644 --- a/docs/answers-core.verticalsearchresponse.uuid.md +++ b/docs/search-core.verticalsearchresponse.uuid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) > [uuid](./answers-core.verticalsearchresponse.uuid.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) > [uuid](./search-core.verticalsearchresponse.uuid.md) ## VerticalSearchResponse.uuid property diff --git a/docs/answers-core.verticalsearchresponse.verticalresults.md b/docs/search-core.verticalsearchresponse.verticalresults.md similarity index 52% rename from docs/answers-core.verticalsearchresponse.verticalresults.md rename to docs/search-core.verticalsearchresponse.verticalresults.md index ec4b5e93..ddd03030 100644 --- a/docs/answers-core.verticalsearchresponse.verticalresults.md +++ b/docs/search-core.verticalsearchresponse.verticalresults.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) > [verticalResults](./answers-core.verticalsearchresponse.verticalresults.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [VerticalSearchResponse](./search-core.verticalsearchresponse.md) > [verticalResults](./search-core.verticalsearchresponse.verticalresults.md) ## VerticalSearchResponse.verticalResults property diff --git a/docs/answers-core.visitor.id.md b/docs/search-core.visitor.id.md similarity index 54% rename from docs/answers-core.visitor.id.md rename to docs/search-core.visitor.id.md index 08562001..c93ee9b4 100644 --- a/docs/answers-core.visitor.id.md +++ b/docs/search-core.visitor.id.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Visitor](./answers-core.visitor.md) > [id](./answers-core.visitor.id.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Visitor](./search-core.visitor.md) > [id](./search-core.visitor.id.md) ## Visitor.id property diff --git a/docs/answers-core.visitor.idmethod.md b/docs/search-core.visitor.idmethod.md similarity index 56% rename from docs/answers-core.visitor.idmethod.md rename to docs/search-core.visitor.idmethod.md index da0dfb12..02128360 100644 --- a/docs/answers-core.visitor.idmethod.md +++ b/docs/search-core.visitor.idmethod.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Visitor](./answers-core.visitor.md) > [idMethod](./answers-core.visitor.idmethod.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Visitor](./search-core.visitor.md) > [idMethod](./search-core.visitor.idmethod.md) ## Visitor.idMethod property diff --git a/docs/answers-core.visitor.md b/docs/search-core.visitor.md similarity index 57% rename from docs/answers-core.visitor.md rename to docs/search-core.visitor.md index 7380cfc4..1af3da2a 100644 --- a/docs/answers-core.visitor.md +++ b/docs/search-core.visitor.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-core](./answers-core.md) > [Visitor](./answers-core.visitor.md) +[Home](./index.md) > [@yext/search-core](./search-core.md) > [Visitor](./search-core.visitor.md) ## Visitor interface @@ -20,6 +20,6 @@ Visitor information is included with every request with the exception of questio | Property | Type | Description | | --- | --- | --- | -| [id](./answers-core.visitor.id.md) | string | The ID associated with the user | -| [idMethod?](./answers-core.visitor.idmethod.md) | string | (Optional) The type of visitor | +| [id](./search-core.visitor.id.md) | string | The ID associated with the user | +| [idMethod?](./search-core.visitor.idmethod.md) | string | (Optional) The type of visitor | diff --git a/etc/answers-core.api.md b/etc/search-core.api.md similarity index 85% rename from etc/answers-core.api.md rename to etc/search-core.api.md index 0de2ea88..37989ba7 100644 --- a/etc/answers-core.api.md +++ b/etc/search-core.api.md @@ -1,4 +1,4 @@ -## API Report File for "@yext/answers-core" +## API Report File for "@yext/search-core" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). @@ -9,44 +9,27 @@ export interface AdditionalHttpHeaders { 'Client-SDK'?: ClientSDKHeaderValues; } -// @public -export type AnswersConfig = AnswersConfigWithApiKey | AnswersConfigWithToken; +// @public @deprecated (undocumented) +export type AnswersConfig = SearchConfig; -// @public -export interface AnswersConfigWithApiKey extends BaseAnswersConfig { - apiKey: string; - token?: never; +// @public @deprecated (undocumented) +export interface AnswersConfigWithApiKey extends SearchConfigWithApiKey { } -// @public -export interface AnswersConfigWithToken extends BaseAnswersConfig { - apiKey?: never; - token: string; +// @public @deprecated (undocumented) +export interface AnswersConfigWithToken extends SearchConfigWithToken { } -// @public -export class AnswersCore { - constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService); - filterSearch(request: FilterSearchRequest): Promise; - submitQuestion(request: QuestionSubmissionRequest): Promise; - universalAutocomplete(request: UniversalAutocompleteRequest): Promise; - universalSearch(request: UniversalSearchRequest): Promise; - verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; - verticalSearch(request: VerticalSearchRequest): Promise; +// @public @deprecated (undocumented) +export class AnswersCore extends SearchCore { } -// @public -export class AnswersError extends Error { - // @internal - constructor(message: string, code?: number, type?: string); - code?: number; - message: string; - type?: string; +// @public @deprecated (undocumented) +export interface AnswersError extends SearchError { } -// @public -export interface AnswersRequest { - additionalHttpHeaders?: AdditionalHttpHeaders; +// @public @deprecated (undocumented) +export interface AnswersRequest extends SearchRequest { } // @public @@ -93,8 +76,12 @@ export interface AutocompleteService { verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; } +// @public @deprecated (undocumented) +export interface BaseAnswersConfig extends BaseSearchConfig { +} + // @public -export interface BaseAnswersConfig { +export interface BaseSearchConfig { // @alpha additionalQueryParams?: { [key: string]: string | number | boolean; @@ -243,7 +230,7 @@ export enum FilterCombinator { } // @public -export interface FilterSearchRequest extends AnswersRequest { +export interface FilterSearchRequest extends SearchRequest { excluded?: Filter[]; fields: SearchParameterField[]; input: string; @@ -347,7 +334,7 @@ export interface NumberRangeValue { } // @public -export function provideCore(config: AnswersConfig): AnswersCore; +export function provideCore(config: SearchConfig): SearchCore; // @public export interface QueryRulesActionsData { @@ -374,7 +361,7 @@ export enum QueryTrigger { } // @public -export interface QuestionSubmissionRequest extends AnswersRequest { +export interface QuestionSubmissionRequest extends SearchRequest { email: string; entityId: string; name: string; @@ -411,6 +398,41 @@ export interface Result { // @public export const SandboxEndpoints: Required; +// @public +export type SearchConfig = SearchConfigWithApiKey | SearchConfigWithToken; + +// @public +export interface SearchConfigWithApiKey extends BaseSearchConfig { + apiKey: string; + token?: never; +} + +// @public +export interface SearchConfigWithToken extends BaseSearchConfig { + apiKey?: never; + token: string; +} + +// @public +export class SearchCore { + constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService); + filterSearch(request: FilterSearchRequest): Promise; + submitQuestion(request: QuestionSubmissionRequest): Promise; + universalAutocomplete(request: UniversalAutocompleteRequest): Promise; + universalSearch(request: UniversalSearchRequest): Promise; + verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; + verticalSearch(request: VerticalSearchRequest): Promise; +} + +// @public +export class SearchError extends Error { + // @internal + constructor(message: string, code?: number, type?: string); + code?: number; + message: string; + type?: string; +} + // @public export enum SearchIntent { NearMe = "NEAR_ME" @@ -423,6 +445,11 @@ export interface SearchParameterField { fieldApiName: string; } +// @public +export interface SearchRequest { + additionalHttpHeaders?: AdditionalHttpHeaders; +} + // @public export interface SearchService { universalSearch(request: UniversalSearchRequest): Promise; @@ -477,7 +504,7 @@ export enum SpellCheckType { } // @public -export interface UniversalAutocompleteRequest extends AnswersRequest { +export interface UniversalAutocompleteRequest extends SearchRequest { input: string; sessionTrackingEnabled?: boolean; } @@ -489,7 +516,7 @@ export interface UniversalLimit { } // @public -export interface UniversalSearchRequest extends AnswersRequest { +export interface UniversalSearchRequest extends SearchRequest { context?: Context; limit?: UniversalLimit; location?: LatLong; @@ -523,7 +550,7 @@ export interface UpperNumberRangeLimit { } // @public -export interface VerticalAutocompleteRequest extends AnswersRequest { +export interface VerticalAutocompleteRequest extends SearchRequest { input: string; sessionTrackingEnabled?: boolean; verticalKey: string; @@ -540,7 +567,7 @@ export interface VerticalResults { } // @public -export interface VerticalSearchRequest extends AnswersRequest { +export interface VerticalSearchRequest extends SearchRequest { context?: Context; facets?: Facet[]; limit?: number; diff --git a/legacy/package.json b/legacy/package.json index ba34d070..8c35f6ad 100644 --- a/legacy/package.json +++ b/legacy/package.json @@ -1,5 +1,5 @@ { - "name": "answers-core-legacy", + "name": "search-core-legacy", "browser": "../dist/bundle.legacy.js", "types": "../dist/bundle.d.ts" } diff --git a/lib/commonjs/package.json b/lib/commonjs/package.json index 31127147..914d79d8 100644 --- a/lib/commonjs/package.json +++ b/lib/commonjs/package.json @@ -1,5 +1,5 @@ { - "name": "answers-core-commonjs", + "name": "search-core-commonjs", "main": "../../dist/commonjs/src", "types": "../../dist/bundle.d.ts" } diff --git a/lib/esm/package.json b/lib/esm/package.json index adc629ec..5687ff80 100644 --- a/lib/esm/package.json +++ b/lib/esm/package.json @@ -1,5 +1,5 @@ { - "name": "answers-core-esm", + "name": "search-core-esm", "module": "../../dist/esm/src", "types": "../../dist/bundle.d.ts" } diff --git a/package-lock.json b/package-lock.json index da3f88b4..8419500b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { - "name": "@yext/answers-core", - "version": "1.7.0", + "name": "@yext/search-core", + "version": "1.8.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "@yext/answers-core", - "version": "1.7.0", + "name": "@yext/search-core", + "version": "1.8.0", "license": "BSD-3-Clause", "dependencies": { "@babel/runtime-corejs3": "^7.12.5", @@ -22,12 +22,12 @@ "@types/jest": "^28.1.1", "@typescript-eslint/eslint-plugin": "^5.16.0", "@typescript-eslint/parser": "^5.16.0", - "@yext/eslint-config-slapshot": "^0.2.0", + "@yext/eslint-config-slapshot": "^0.4.0", "@yext/eslint-plugin-export-star": "^1.0.2", "babel-jest": "^26.6.1", "babel-loader": "^8.2.2", "eslint": "^8.11.0", - "eslint-config-react-app": "^7.0.0", + "eslint-config-react-app": "^7.0.1", "eslint-plugin-tsdoc": "^0.2.14", "generate-license-file": "^1.3.0", "jest": "^28.1.0", @@ -114,9 +114,9 @@ } }, "node_modules/@babel/eslint-parser": { - "version": "7.17.0", - "resolved": "https://registry.npmjs.org/@babel/eslint-parser/-/eslint-parser-7.17.0.tgz", - "integrity": "sha512-PUEJ7ZBXbRkbq3qqM/jZ2nIuakUBqCYc7Qf52Lj7dlZ6zERnqisdHioL0l4wwQZnmskMeasqUNzLBFKs3nylXA==", + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/@babel/eslint-parser/-/eslint-parser-7.18.2.tgz", + "integrity": "sha512-oFQYkE8SuH14+uR51JVAmdqwKYXGRjEXx7s+WiagVjqQ+HPE+nnwyF2qlVG8evUsUHmPcA+6YXMEDbIhEyQc5A==", "dev": true, "dependencies": { "eslint-scope": "^5.1.1", @@ -150,14 +150,14 @@ } }, "node_modules/@babel/generator": { - "version": "7.17.7", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.17.7.tgz", - "integrity": "sha512-oLcVCTeIFadUoArDTwpluncplrYBmTCCZZgXCbgNGvOBBiSDDK3eWO4b/+eOTli5tKv1lg+a5/NAXg+nTcei1w==", + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.18.2.tgz", + "integrity": "sha512-W1lG5vUwFvfMd8HVXqdfbuG7RuaSrTCCD8cl8fP8wOivdbtbIg2Db3IWUcgvfxKbbn6ZBGYRW/Zk1MIwK49mgw==", "dev": true, "dependencies": { - "@babel/types": "^7.17.0", - "jsesc": "^2.5.1", - "source-map": "^0.5.0" + "@babel/types": "^7.18.2", + "@jridgewell/gen-mapping": "^0.3.0", + "jsesc": "^2.5.1" }, "engines": { "node": ">=6.9.0" @@ -216,15 +216,15 @@ } }, "node_modules/@babel/helper-create-class-features-plugin": { - "version": "7.17.6", - "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.17.6.tgz", - "integrity": "sha512-SogLLSxXm2OkBbSsHZMM4tUi8fUzjs63AT/d0YQIzr6GSd8Hxsbk2KYDX0k0DweAzGMj/YWeiCsorIdtdcW8Eg==", + "version": "7.18.0", + "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.18.0.tgz", + "integrity": "sha512-Kh8zTGR9de3J63e5nS0rQUdRs/kbtwoeQQ0sriS0lItjC96u8XXZN6lKpuyWd2coKSU13py/y+LTmThLuVX0Pg==", "dev": true, "dependencies": { "@babel/helper-annotate-as-pure": "^7.16.7", "@babel/helper-environment-visitor": "^7.16.7", - "@babel/helper-function-name": "^7.16.7", - "@babel/helper-member-expression-to-functions": "^7.16.7", + "@babel/helper-function-name": "^7.17.9", + "@babel/helper-member-expression-to-functions": "^7.17.7", "@babel/helper-optimise-call-expression": "^7.16.7", "@babel/helper-replace-supers": "^7.16.7", "@babel/helper-split-export-declaration": "^7.16.7" @@ -281,13 +281,10 @@ } }, "node_modules/@babel/helper-environment-visitor": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/helper-environment-visitor/-/helper-environment-visitor-7.16.7.tgz", - "integrity": "sha512-SLLb0AAn6PkUeAfKJCCOl9e1R53pQlGAfc4y4XuMRZfqeMYLE0dM1LMhqbGAlGQY0lfw5/ohoYWAe9V1yibRag==", + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/@babel/helper-environment-visitor/-/helper-environment-visitor-7.18.2.tgz", + "integrity": "sha512-14GQKWkX9oJzPiQQ7/J36FTXcD4kSp8egKjO9nINlSKiHITRA9q/R74qu8S9xlc/b/yjsJItQUeeh3xnGN0voQ==", "dev": true, - "dependencies": { - "@babel/types": "^7.16.7" - }, "engines": { "node": ">=6.9.0" } @@ -305,26 +302,13 @@ } }, "node_modules/@babel/helper-function-name": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.16.7.tgz", - "integrity": "sha512-QfDfEnIUyyBSR3HtrtGECuZ6DAyCkYFp7GHl75vFtTnn6pjKeK0T1DB5lLkFvBea8MdaiUABx3osbgLyInoejA==", + "version": "7.17.9", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.17.9.tgz", + "integrity": "sha512-7cRisGlVtiVqZ0MW0/yFB4atgpGLWEHUVYnb448hZK4x+vih0YO5UoS11XIYtZYqHd0dIPMdUSv8q5K4LdMnIg==", "dev": true, "dependencies": { - "@babel/helper-get-function-arity": "^7.16.7", "@babel/template": "^7.16.7", - "@babel/types": "^7.16.7" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-get-function-arity": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.16.7.tgz", - "integrity": "sha512-flc+RLSOBXzNzVhcLu6ujeHUrD6tANAOU5ojrRx/as+tbzf8+stUCj7+IfRRoAbEZqj/ahXEMsjhOhgeZsrnTw==", - "dev": true, - "dependencies": { - "@babel/types": "^7.16.7" + "@babel/types": "^7.17.0" }, "engines": { "node": ">=6.9.0" @@ -398,9 +382,9 @@ } }, "node_modules/@babel/helper-plugin-utils": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.16.7.tgz", - "integrity": "sha512-Qg3Nk7ZxpgMrsox6HreY1ZNKdBq7K72tDSliA6dCl5f007jR4ne8iD5UzuNnCJH2xBf2BEEVGr+/OL6Gdp7RxA==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.17.12.tgz", + "integrity": "sha512-JDkf04mqtN3y4iAbO1hv9U2ARpPyPL1zqyWs/2WG1pgSq9llHFjStX5jdxb84himgJm+8Ng+x0oiWF/nw/XQKA==", "dev": true, "engines": { "node": ">=6.9.0" @@ -421,16 +405,16 @@ } }, "node_modules/@babel/helper-replace-supers": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.16.7.tgz", - "integrity": "sha512-y9vsWilTNaVnVh6xiJfABzsNpgDPKev9HnAgz6Gb1p6UUwf9NepdlsV7VXGCftJM+jqD5f7JIEubcpLjZj5dBw==", + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.18.2.tgz", + "integrity": "sha512-XzAIyxx+vFnrOxiQrToSUOzUOn0e1J2Li40ntddek1Y69AXUTXoDJ40/D5RdjFu7s7qHiaeoTiempZcbuVXh2Q==", "dev": true, "dependencies": { - "@babel/helper-environment-visitor": "^7.16.7", - "@babel/helper-member-expression-to-functions": "^7.16.7", + "@babel/helper-environment-visitor": "^7.18.2", + "@babel/helper-member-expression-to-functions": "^7.17.7", "@babel/helper-optimise-call-expression": "^7.16.7", - "@babel/traverse": "^7.16.7", - "@babel/types": "^7.16.7" + "@babel/traverse": "^7.18.2", + "@babel/types": "^7.18.2" }, "engines": { "node": ">=6.9.0" @@ -534,9 +518,9 @@ } }, "node_modules/@babel/parser": { - "version": "7.17.8", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.17.8.tgz", - "integrity": "sha512-BoHhDJrJXqcg+ZL16Xv39H9n+AqJ4pcDrQBGZN+wHxIysrLZ3/ECwCBUch/1zUNhnsXULcONU3Ei5Hmkfk6kiQ==", + "version": "7.18.5", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.18.5.tgz", + "integrity": "sha512-YZWVaglMiplo7v8f1oMQ5ZPQr0vn7HPeZXxXWsxXJRjGVrzUFn9OxFQl1sb5wzfootjA/yChhW84BV+383FSOw==", "dev": true, "bin": { "parser": "bin/babel-parser.js" @@ -628,15 +612,16 @@ } }, "node_modules/@babel/plugin-proposal-decorators": { - "version": "7.17.8", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-decorators/-/plugin-proposal-decorators-7.17.8.tgz", - "integrity": "sha512-U69odN4Umyyx1xO1rTII0IDkAEC+RNlcKXtqOblfpzqy1C+aOplb76BQNq0+XdpVkOaPlpEDwd++joY8FNFJKA==", + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-decorators/-/plugin-proposal-decorators-7.18.2.tgz", + "integrity": "sha512-kbDISufFOxeczi0v4NQP3p5kIeW6izn/6klfWBrIIdGZZe4UpHR+QU03FAoWjGGd9SUXAwbw2pup1kaL4OQsJQ==", "dev": true, "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.17.6", - "@babel/helper-plugin-utils": "^7.16.7", - "@babel/helper-replace-supers": "^7.16.7", - "@babel/plugin-syntax-decorators": "^7.17.0", + "@babel/helper-create-class-features-plugin": "^7.18.0", + "@babel/helper-plugin-utils": "^7.17.12", + "@babel/helper-replace-supers": "^7.18.2", + "@babel/helper-split-export-declaration": "^7.16.7", + "@babel/plugin-syntax-decorators": "^7.17.12", "charcodes": "^0.2.0" }, "engines": { @@ -896,12 +881,12 @@ } }, "node_modules/@babel/plugin-syntax-decorators": { - "version": "7.17.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-decorators/-/plugin-syntax-decorators-7.17.0.tgz", - "integrity": "sha512-qWe85yCXsvDEluNP0OyeQjH63DlhAR3W7K9BxxU1MvbDb48tgBG+Ao6IJJ6smPDrrVzSQZrbF6donpkFBMcs3A==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-decorators/-/plugin-syntax-decorators-7.17.12.tgz", + "integrity": "sha512-D1Hz0qtGTza8K2xGyEdVNCYLdVHukAcbQr4K3/s6r/esadyEriZovpJimQOpu8ju4/jV8dW/1xdaE0UpDroidw==", "dev": true, "dependencies": { - "@babel/helper-plugin-utils": "^7.16.7" + "@babel/helper-plugin-utils": "^7.17.12" }, "engines": { "node": ">=6.9.0" @@ -935,12 +920,12 @@ } }, "node_modules/@babel/plugin-syntax-flow": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-flow/-/plugin-syntax-flow-7.16.7.tgz", - "integrity": "sha512-UDo3YGQO0jH6ytzVwgSLv9i/CzMcUjbKenL67dTrAZPPv6GFAtDhe6jqnvmoKzC/7htNTohhos+onPtDMqJwaQ==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-flow/-/plugin-syntax-flow-7.17.12.tgz", + "integrity": "sha512-B8QIgBvkIG6G2jgsOHQUist7Sm0EBLDCx8sen072IwqNuzMegZNXrYnSv77cYzA8mLDZAfQYqsLIhimiP1s2HQ==", "dev": true, "dependencies": { - "@babel/helper-plugin-utils": "^7.16.7" + "@babel/helper-plugin-utils": "^7.17.12" }, "engines": { "node": ">=6.9.0" @@ -974,12 +959,12 @@ } }, "node_modules/@babel/plugin-syntax-jsx": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.16.7.tgz", - "integrity": "sha512-Esxmk7YjA8QysKeT3VhTXvF6y77f/a91SIs4pWb4H2eWGQkCKFgQaG6hdoEVZtGsrAcb2K5BW66XsOErD4WU3Q==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.17.12.tgz", + "integrity": "sha512-spyY3E3AURfxh/RHtjx5j6hs8am5NbUBGfcZ2vB3uShSpZdQyXSf5rR5Mk76vbtlAZOelyVQ71Fg0x9SG4fsog==", "dev": true, "dependencies": { - "@babel/helper-plugin-utils": "^7.16.7" + "@babel/helper-plugin-utils": "^7.17.12" }, "engines": { "node": ">=6.9.0" @@ -1267,13 +1252,13 @@ } }, "node_modules/@babel/plugin-transform-flow-strip-types": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-flow-strip-types/-/plugin-transform-flow-strip-types-7.16.7.tgz", - "integrity": "sha512-mzmCq3cNsDpZZu9FADYYyfZJIOrSONmHcop2XEKPdBNMa4PDC4eEvcOvzZaCNcjKu72v0XQlA5y1g58aLRXdYg==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-flow-strip-types/-/plugin-transform-flow-strip-types-7.17.12.tgz", + "integrity": "sha512-g8cSNt+cHCpG/uunPQELdq/TeV3eg1OLJYwxypwHtAWo9+nErH3lQx9CSO2uI9lF74A0mR0t4KoMjs1snSgnTw==", "dev": true, "dependencies": { - "@babel/helper-plugin-utils": "^7.16.7", - "@babel/plugin-syntax-flow": "^7.16.7" + "@babel/helper-plugin-utils": "^7.17.12", + "@babel/plugin-syntax-flow": "^7.17.12" }, "engines": { "node": ">=6.9.0" @@ -1506,16 +1491,16 @@ } }, "node_modules/@babel/plugin-transform-react-jsx": { - "version": "7.17.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.17.3.tgz", - "integrity": "sha512-9tjBm4O07f7mzKSIlEmPdiE6ub7kfIe6Cd+w+oQebpATfTQMAgW+YOuWxogbKVTulA+MEO7byMeIUtQ1z+z+ZQ==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.17.12.tgz", + "integrity": "sha512-Lcaw8bxd1DKht3thfD4A12dqo1X16he1Lm8rIv8sTwjAYNInRS1qHa9aJoqvzpscItXvftKDCfaEQzwoVyXpEQ==", "dev": true, "dependencies": { "@babel/helper-annotate-as-pure": "^7.16.7", "@babel/helper-module-imports": "^7.16.7", - "@babel/helper-plugin-utils": "^7.16.7", - "@babel/plugin-syntax-jsx": "^7.16.7", - "@babel/types": "^7.17.0" + "@babel/helper-plugin-utils": "^7.17.12", + "@babel/plugin-syntax-jsx": "^7.17.12", + "@babel/types": "^7.17.12" }, "engines": { "node": ">=6.9.0" @@ -1540,13 +1525,13 @@ } }, "node_modules/@babel/plugin-transform-react-pure-annotations": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.16.7.tgz", - "integrity": "sha512-hs71ToC97k3QWxswh2ElzMFABXHvGiJ01IB1TbYQDGeWRKWz/MPUTh5jGExdHvosYKpnJW5Pm3S4+TA3FyX+GA==", + "version": "7.18.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.18.0.tgz", + "integrity": "sha512-6+0IK6ouvqDn9bmEG7mEyF/pwlJXVj5lwydybpyyH3D0A7Hftk+NCTdYjnLNZksn261xaOV5ksmp20pQEmc2RQ==", "dev": true, "dependencies": { "@babel/helper-annotate-as-pure": "^7.16.7", - "@babel/helper-plugin-utils": "^7.16.7" + "@babel/helper-plugin-utils": "^7.17.12" }, "engines": { "node": ">=6.9.0" @@ -1852,15 +1837,15 @@ } }, "node_modules/@babel/preset-react": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.16.7.tgz", - "integrity": "sha512-fWpyI8UM/HE6DfPBzD8LnhQ/OcH8AgTaqcqP2nGOXEUV+VKBR5JRN9hCk9ai+zQQ57vtm9oWeXguBCPNUjytgA==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.17.12.tgz", + "integrity": "sha512-h5U+rwreXtZaRBEQhW1hOJLMq8XNJBQ/9oymXiCXTuT/0uOwpbT0gUt+sXeOqoXBgNuUKI7TaObVwoEyWkpFgA==", "dev": true, "dependencies": { - "@babel/helper-plugin-utils": "^7.16.7", + "@babel/helper-plugin-utils": "^7.17.12", "@babel/helper-validator-option": "^7.16.7", "@babel/plugin-transform-react-display-name": "^7.16.7", - "@babel/plugin-transform-react-jsx": "^7.16.7", + "@babel/plugin-transform-react-jsx": "^7.17.12", "@babel/plugin-transform-react-jsx-development": "^7.16.7", "@babel/plugin-transform-react-pure-annotations": "^7.16.7" }, @@ -1924,19 +1909,19 @@ } }, "node_modules/@babel/traverse": { - "version": "7.17.3", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.17.3.tgz", - "integrity": "sha512-5irClVky7TxRWIRtxlh2WPUUOLhcPN06AGgaQSB8AEwuyEBgJVuJ5imdHm5zxk8w0QS5T+tDfnDxAlhWjpb7cw==", + "version": "7.18.5", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.18.5.tgz", + "integrity": "sha512-aKXj1KT66sBj0vVzk6rEeAO6Z9aiiQ68wfDgge3nHhA/my6xMM/7HGQUNumKZaoa2qUPQ5whJG9aAifsxUKfLA==", "dev": true, "dependencies": { "@babel/code-frame": "^7.16.7", - "@babel/generator": "^7.17.3", - "@babel/helper-environment-visitor": "^7.16.7", - "@babel/helper-function-name": "^7.16.7", + "@babel/generator": "^7.18.2", + "@babel/helper-environment-visitor": "^7.18.2", + "@babel/helper-function-name": "^7.17.9", "@babel/helper-hoist-variables": "^7.16.7", "@babel/helper-split-export-declaration": "^7.16.7", - "@babel/parser": "^7.17.3", - "@babel/types": "^7.17.0", + "@babel/parser": "^7.18.5", + "@babel/types": "^7.18.4", "debug": "^4.1.0", "globals": "^11.1.0" }, @@ -1945,9 +1930,9 @@ } }, "node_modules/@babel/types": { - "version": "7.17.0", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.17.0.tgz", - "integrity": "sha512-TmKSNO4D5rzhL5bjWFcVHHLETzfQ/AmbKpKPOSjlP0WoHZ6L911fgoOKY4Alp/emzG4cHJdyN49zpgkbXFEHHw==", + "version": "7.18.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.18.4.tgz", + "integrity": "sha512-ThN1mBcMq5pG/Vm2IcBmPPfyPXbd8S02rS+OBIDENdufvqC7Z/jHPCv9IcP01277aKtDI8g/2XysBN4hA8niiw==", "dev": true, "dependencies": { "@babel/helper-validator-identifier": "^7.16.7", @@ -3993,9 +3978,9 @@ } }, "node_modules/@rushstack/eslint-patch": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/@rushstack/eslint-patch/-/eslint-patch-1.1.1.tgz", - "integrity": "sha512-BUyKJGdDWqvWC5GEhyOiUrGNi9iJUr4CU0O2WxJL6QJhHeeA/NVBalH+FeK0r/x/W0rPymXt5s78TDS7d6lCwg==", + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rushstack/eslint-patch/-/eslint-patch-1.1.3.tgz", + "integrity": "sha512-WiBSI6JBIhC6LRIsB2Kwh8DsGTlbBU+mLRxJmAe3LjHTdkDpwIbEOZgoXBbZilk/vlfjK8i6nKRAvIRn1XaIMw==", "dev": true }, "node_modules/@rushstack/node-core-library": { @@ -4742,12 +4727,13 @@ "dev": true }, "node_modules/@yext/eslint-config-slapshot": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/@yext/eslint-config-slapshot/-/eslint-config-slapshot-0.2.0.tgz", - "integrity": "sha512-6j2N/XXnl6inGg/VVEFXC1Kf4QdVNHHTxWG7F7R0xcK8pB2NMOyk23MLiVHNyin2R3xHzj29h7MmWBATsRCIWg==", + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/@yext/eslint-config-slapshot/-/eslint-config-slapshot-0.4.0.tgz", + "integrity": "sha512-YxZ4KRbgjlW0i1oTLL0czHv32hPx+FMRIYOXowqns9JCa04R6FtMjukGzD1xM5OaWklk7px+vJX0PpYV/VIIIw==", "dev": true, + "hasInstallScript": true, "dependencies": { - "eslint-config-react-app": "^7.0.0" + "eslint-config-react-app": "^7.0.1" }, "peerDependencies": { "@typescript-eslint/eslint-plugin": "^5.15.0", @@ -5003,14 +4989,14 @@ } }, "node_modules/array-includes": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.4.tgz", - "integrity": "sha512-ZTNSQkmWumEbiHO2GF4GmWxYVTiQyJy2XOTa15sdQSrvKn7l+180egQMqlrMOUMCyLMD7pmyQe4mMDUT6Behrw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.5.tgz", + "integrity": "sha512-iSDYZMMyTPkiFasVqfuAQnWAYcvO/SeBSCGKePoEthjp4LEMTe4uLc7b025o4jAZpHhihh8xPo99TNWUWWkGDQ==", "dev": true, "dependencies": { "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.1", + "define-properties": "^1.1.4", + "es-abstract": "^1.19.5", "get-intrinsic": "^1.1.1", "is-string": "^1.0.7" }, @@ -5057,14 +5043,15 @@ } }, "node_modules/array.prototype.flatmap": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.2.5.tgz", - "integrity": "sha512-08u6rVyi1Lj7oqWbS9nUxliETrtIROT4XGTA4D/LWGten6E3ocm7cy9SIrmNHOL5XVbVuckUp3X6Xyg8/zpvHA==", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.0.tgz", + "integrity": "sha512-PZC9/8TKAIxcWKdyeb77EzULHPrIX/tIZebLJUQOMR1OwYosT8yggdfWScfTBCDj5utONvOuPQQumYsU2ULbkg==", "dev": true, "dependencies": { - "call-bind": "^1.0.0", + "call-bind": "^1.0.2", "define-properties": "^1.1.3", - "es-abstract": "^1.19.0" + "es-abstract": "^1.19.2", + "es-shim-unscopables": "^1.0.0" }, "engines": { "node": ">= 0.4" @@ -5091,7 +5078,7 @@ "node_modules/ast-types-flow": { "version": "0.0.7", "resolved": "https://registry.npmjs.org/ast-types-flow/-/ast-types-flow-0.0.7.tgz", - "integrity": "sha1-9wtzXGvKGlycItmCw+Oef+ujva0=", + "integrity": "sha512-eBvWn1lvIApYMhzQMsu9ciLfkBY499mFZlNqG+/9WR7PVlroQw0vG30cOQQbaKz3sCEc44TAOu2ykzqXSNnwag==", "dev": true }, "node_modules/asynckit": { @@ -5113,12 +5100,12 @@ } }, "node_modules/axe-core": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.4.1.tgz", - "integrity": "sha512-gd1kmb21kwNuWr6BQz8fv6GNECPBnUasepcoLbekws23NVBLODdsClRZ+bQ8+9Uomf3Sm3+Vwn0oYG9NvwnJCw==", + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.4.2.tgz", + "integrity": "sha512-LVAaGp/wkkgYJcjmHsoKx4juT1aQvJyPcW09MLCjVTh3V2cc6PnyempiLMNH5iMdfIX/zdbjUx2KDjMLCTdPeA==", "dev": true, "engines": { - "node": ">=4" + "node": ">=12" } }, "node_modules/axobject-query": { @@ -6196,15 +6183,19 @@ } }, "node_modules/define-properties": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", - "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.4.tgz", + "integrity": "sha512-uckOqKcfaVvtBdsVkdPv3XjveQJsNQqmhXgRi8uhvWWuPYZCNlzT8qAyblUgNoXdHdjMTzAqeGjAoli8f+bzPA==", "dev": true, "dependencies": { - "object-keys": "^1.0.12" + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" }, "engines": { "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, "node_modules/define-property": { @@ -6394,31 +6385,34 @@ } }, "node_modules/es-abstract": { - "version": "1.19.1", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.19.1.tgz", - "integrity": "sha512-2vJ6tjA/UfqLm2MPs7jxVybLoB8i1t1Jd9R3kISld20sIxPcTbLuggQOUxeWeAvIUkduv/CfMjuh4WmiXr2v9w==", + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.20.1.tgz", + "integrity": "sha512-WEm2oBhfoI2sImeM4OF2zE2V3BYdSF+KnSi9Sidz51fQHd7+JuF8Xgcj9/0o+OWeIeIS/MiuNnlruQrJf16GQA==", "dev": true, "dependencies": { "call-bind": "^1.0.2", "es-to-primitive": "^1.2.1", "function-bind": "^1.1.1", + "function.prototype.name": "^1.1.5", "get-intrinsic": "^1.1.1", "get-symbol-description": "^1.0.0", "has": "^1.0.3", - "has-symbols": "^1.0.2", + "has-property-descriptors": "^1.0.0", + "has-symbols": "^1.0.3", "internal-slot": "^1.0.3", "is-callable": "^1.2.4", - "is-negative-zero": "^2.0.1", + "is-negative-zero": "^2.0.2", "is-regex": "^1.1.4", - "is-shared-array-buffer": "^1.0.1", + "is-shared-array-buffer": "^1.0.2", "is-string": "^1.0.7", - "is-weakref": "^1.0.1", - "object-inspect": "^1.11.0", + "is-weakref": "^1.0.2", + "object-inspect": "^1.12.0", "object-keys": "^1.1.1", "object.assign": "^4.1.2", - "string.prototype.trimend": "^1.0.4", - "string.prototype.trimstart": "^1.0.4", - "unbox-primitive": "^1.0.1" + "regexp.prototype.flags": "^1.4.3", + "string.prototype.trimend": "^1.0.5", + "string.prototype.trimstart": "^1.0.5", + "unbox-primitive": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -6433,6 +6427,15 @@ "integrity": "sha512-1HQ2M2sPtxwnvOvT1ZClHyQDiggdNjURWpY2we6aMKCQiUVxTmVs2UYPLIrD84sS+kMdUwfBSylbJPwNnBrnHQ==", "dev": true }, + "node_modules/es-shim-unscopables": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.0.0.tgz", + "integrity": "sha512-Jm6GPcCdC30eMLbZ2x8z2WuRwAws3zTBBKuusffYVUrNj/GVSUAZ+xKMaUpfNDR5IbyNA5LJbaecoUVbmUcB1w==", + "dev": true, + "dependencies": { + "has": "^1.0.3" + } + }, "node_modules/es-to-primitive": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", @@ -6625,9 +6628,9 @@ } }, "node_modules/eslint-config-react-app": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/eslint-config-react-app/-/eslint-config-react-app-7.0.0.tgz", - "integrity": "sha512-xyymoxtIt1EOsSaGag+/jmcywRuieQoA2JbPCjnw9HukFj9/97aGPoZVFioaotzk1K5Qt9sHO5EutZbkrAXS0g==", + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/eslint-config-react-app/-/eslint-config-react-app-7.0.1.tgz", + "integrity": "sha512-K6rNzvkIeHaTd8m/QEh1Zko0KI7BACWkkneSs6s9cKZC/J27X3eZR6Upt1jkmZ/4FK+XUOPPxMEN7+lbUXfSlA==", "dev": true, "dependencies": { "@babel/core": "^7.16.0", @@ -6954,25 +6957,25 @@ } }, "node_modules/eslint-plugin-react": { - "version": "7.29.4", - "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.29.4.tgz", - "integrity": "sha512-CVCXajliVh509PcZYRFyu/BoUEz452+jtQJq2b3Bae4v3xBUWPLCmtmBM+ZinG4MzwmxJgJ2M5rMqhqLVn7MtQ==", + "version": "7.30.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.30.0.tgz", + "integrity": "sha512-RgwH7hjW48BleKsYyHK5vUAvxtE9SMPDKmcPRQgtRCYaZA0XQPt5FSkrU3nhz5ifzMZcA8opwmRJ2cmOO8tr5A==", "dev": true, "dependencies": { - "array-includes": "^3.1.4", - "array.prototype.flatmap": "^1.2.5", + "array-includes": "^3.1.5", + "array.prototype.flatmap": "^1.3.0", "doctrine": "^2.1.0", "estraverse": "^5.3.0", "jsx-ast-utils": "^2.4.1 || ^3.0.0", "minimatch": "^3.1.2", "object.entries": "^1.1.5", "object.fromentries": "^2.0.5", - "object.hasown": "^1.1.0", + "object.hasown": "^1.1.1", "object.values": "^1.1.5", "prop-types": "^15.8.1", "resolve": "^2.0.0-next.3", "semver": "^6.3.0", - "string.prototype.matchall": "^4.0.6" + "string.prototype.matchall": "^4.0.7" }, "engines": { "node": ">=4" @@ -6982,9 +6985,9 @@ } }, "node_modules/eslint-plugin-react-hooks": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-4.3.0.tgz", - "integrity": "sha512-XslZy0LnMn+84NEG9jSGR6eGqaZB3133L8xewQo3fQagbQuGt7a63gf+P1NGKZavEYEC3UXaWEAA/AqDkuN6xA==", + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-4.6.0.tgz", + "integrity": "sha512-oFc7Itz9Qxh2x4gNHStv3BqJq54ExXmfC+a1NjAta66IAN87Wu0R/QArgIS9qKzX3dXKPI9H5crl9QchNMY9+g==", "dev": true, "engines": { "node": ">=10" @@ -7028,13 +7031,17 @@ } }, "node_modules/eslint-plugin-react/node_modules/resolve": { - "version": "2.0.0-next.3", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.3.tgz", - "integrity": "sha512-W8LucSynKUIDu9ylraa7ueVZ7hc0uAgJBxVsQSKOXOyle8a93qXhcz+XAXZ8bIq2d6i4Ehddn6Evt+0/UwKk6Q==", + "version": "2.0.0-next.4", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.4.tgz", + "integrity": "sha512-iMDbmAWtfU+MHpxt/I5iWI7cY6YVEZUQ3MBgPQ++XD1PELuJHIl82xBmObyP2KyQmkNB2dsqF7seoQQiAn5yDQ==", "dev": true, "dependencies": { - "is-core-module": "^2.2.0", - "path-parse": "^1.0.6" + "is-core-module": "^2.9.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -7050,9 +7057,9 @@ } }, "node_modules/eslint-plugin-testing-library": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-testing-library/-/eslint-plugin-testing-library-5.1.0.tgz", - "integrity": "sha512-YSNzasJUbyhOTe14ZPygeOBvcPvcaNkwHwrj4vdf+uirr2D32JTDaKi6CP5Os2aWtOcvt4uBSPXp9h5xGoqvWQ==", + "version": "5.5.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-testing-library/-/eslint-plugin-testing-library-5.5.1.tgz", + "integrity": "sha512-plLEkkbAKBjPxsLj7x4jNapcHAg2ernkQlKKrN2I8NrQwPISZHyCUNvg5Hv3EDqOQReToQb5bnqXYbkijJPE/g==", "dev": true, "dependencies": { "@typescript-eslint/utils": "^5.13.0" @@ -8072,12 +8079,39 @@ "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", "dev": true }, + "node_modules/function.prototype.name": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.5.tgz", + "integrity": "sha512-uN7m/BzVKQnCUF/iW8jYea67v++2u7m5UgENbHRtdDVclOUP+FMPlCNdmk0h/ysGyo2tavMJEDqJAkJdRa1vMA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.0", + "functions-have-names": "^1.2.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/functional-red-black-tree": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", "dev": true }, + "node_modules/functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/generate-license-file": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/generate-license-file/-/generate-license-file-1.3.0.tgz", @@ -8262,9 +8296,9 @@ } }, "node_modules/has-bigints": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", - "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz", + "integrity": "sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ==", "dev": true, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -8279,6 +8313,18 @@ "node": ">=4" } }, + "node_modules/has-property-descriptors": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.0.tgz", + "integrity": "sha512-62DVLZGoiEBDHQyqG4w9xCuZ7eJEwNmJRWw2VY84Oedb7WFcA27fiEVe8oUQx9hAUJ4ekurquucTGwsyO1XGdQ==", + "dev": true, + "dependencies": { + "get-intrinsic": "^1.1.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/has-symbols": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", @@ -8719,9 +8765,9 @@ } }, "node_modules/is-core-module": { - "version": "2.8.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.8.1.tgz", - "integrity": "sha512-SdNCUs284hr40hFTFP6l0IfZ/RSrMXF3qgoRHd3/79unUTvrFO/JoXwkGm+5J/Oe3E/b5GsnG330uUNgRpu1PA==", + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.9.0.tgz", + "integrity": "sha512-+5FPy5PnwmO3lvfMb0AsoPaBG+5KHUI0wYFXOtYPnVVVspTFUuMZNfNaNVRt3FZadstu2c8x23vykRW/NBoU6A==", "dev": true, "dependencies": { "has": "^1.0.3" @@ -8853,9 +8899,9 @@ } }, "node_modules/is-number-object": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.6.tgz", - "integrity": "sha512-bEVOqiRcvo3zO1+G2lVMy+gkkEm9Yh7cDMRusKKu5ZJKPUYSJwICTKZrNKHA2EbSP0Tu0+6B/emsYNHZyn6K8g==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.7.tgz", + "integrity": "sha512-k1U0IRzLMo7ZlYIfzRu23Oh6MiIFasgpb9X76eqfFZAqwH44UI4KTBvBYIZ1dSL9ZzChTB9ShHfLkR4pdW5krQ==", "dev": true, "dependencies": { "has-tostringtag": "^1.0.0" @@ -8902,10 +8948,13 @@ } }, "node_modules/is-shared-array-buffer": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.1.tgz", - "integrity": "sha512-IU0NmyknYZN0rChcKhRO1X8LYz5Isj/Fsqh8NJOSf+N/hCOTwy29F32Ik7a+QszE63IdvmwdTPDd6cZ5pg4cwA==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.2.tgz", + "integrity": "sha512-sqN2UDu1/0y6uvXyStCOzyhAjCSlHceFoMKJW8W9EU9cvic/QdsZ0kEU93HEy3IUEFZIiH/3w+AH/UQbPHNdhA==", "dev": true, + "dependencies": { + "call-bind": "^1.0.2" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -12539,9 +12588,9 @@ } }, "node_modules/jsx-ast-utils": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.2.2.tgz", - "integrity": "sha512-HDAyJ4MNQBboGpUnHAVUNJs6X0lh058s6FuixsFGP7MgJYpD6Vasd6nzSG5iIfXu1zAYlHJ/zsOKNlrenTUBnw==", + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.3.0.tgz", + "integrity": "sha512-XzO9luP6L0xkxwhIJMTJQpZo/eeN60K08jHdexfD569AGxeNug6UketeHXEhROoM8aR7EcUoOQmIhcJQjcuq8Q==", "dev": true, "dependencies": { "array-includes": "^3.1.4", @@ -12578,7 +12627,7 @@ "node_modules/language-tags": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/language-tags/-/language-tags-1.0.5.tgz", - "integrity": "sha1-0yHbxNowuovzAk4ED6XBRmH5GTo=", + "integrity": "sha512-qJhlO9cGXi6hBGKoxEG/sKZDAHD5Hnu9Hs4WbOY3pCWXDhw0N8x1NenNzm2EnNLkLkk7J2SdxAkDSbb6ftT+UQ==", "dev": true, "dependencies": { "language-subtag-registry": "~0.3.2" @@ -13074,7 +13123,7 @@ "node_modules/object-assign": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", - "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", + "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", "dev": true, "engines": { "node": ">=0.10.0" @@ -13245,13 +13294,13 @@ } }, "node_modules/object.hasown": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/object.hasown/-/object.hasown-1.1.0.tgz", - "integrity": "sha512-MhjYRfj3GBlhSkDHo6QmvgjRLXQ2zndabdf3nX0yTyZK9rPfxb6uRpAac8HXNLy1GpqWtZ81Qh4v3uOls2sRAg==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object.hasown/-/object.hasown-1.1.1.tgz", + "integrity": "sha512-LYLe4tivNQzq4JdaWW6WO3HMZZJWzkkH8fnI6EebWl0VZth2wL2Lovm74ep2/gZzlaTdV62JZHEqHQ2yVn8Q/A==", "dev": true, "dependencies": { - "define-properties": "^1.1.3", - "es-abstract": "^1.19.1" + "define-properties": "^1.1.4", + "es-abstract": "^1.19.5" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -13875,13 +13924,14 @@ } }, "node_modules/regexp.prototype.flags": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.1.tgz", - "integrity": "sha512-pMR7hBVUUGI7PMA37m2ofIdQCsomVnas+Jn5UPGAHQ+/LlwKm/aTLJHdasmHRzlfeZwHiAOaRSo2rbBDm3nNUQ==", + "version": "1.4.3", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.3.tgz", + "integrity": "sha512-fjggEOO3slI6Wvgjwflkc4NFRCTZAu5CnNfBd5qOMYhWdn67nJBBu34/TkD++eeFmd8C9r9jfXJ27+nSiRkSUA==", "dev": true, "dependencies": { "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "define-properties": "^1.1.3", + "functions-have-names": "^1.2.2" }, "engines": { "node": ">= 0.4" @@ -15103,26 +15153,28 @@ } }, "node_modules/string.prototype.trimend": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", - "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.5.tgz", + "integrity": "sha512-I7RGvmjV4pJ7O3kdf+LXFpVfdNOxtCW/2C8f6jNiW4+PQchwxkCDzlk1/7p+Wl4bqFIZeF47qAHXLuHHWKAxog==", "dev": true, "dependencies": { "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "define-properties": "^1.1.4", + "es-abstract": "^1.19.5" }, "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/string.prototype.trimstart": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", - "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.5.tgz", + "integrity": "sha512-THx16TJCGlsN0o6dl2o6ncWUsdgnLRSA23rRE5pyGBw/mLr3Ej/R2LaqCtgP8VNMGZsvMWnf9ooZPyY2bHvUFg==", "dev": true, "dependencies": { "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "define-properties": "^1.1.4", + "es-abstract": "^1.19.5" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -15747,14 +15799,14 @@ } }, "node_modules/unbox-primitive": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", - "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", + "integrity": "sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==", "dev": true, "dependencies": { - "function-bind": "^1.1.1", - "has-bigints": "^1.0.1", - "has-symbols": "^1.0.2", + "call-bind": "^1.0.2", + "has-bigints": "^1.0.2", + "has-symbols": "^1.0.3", "which-boxed-primitive": "^1.0.2" }, "funding": { @@ -16472,9 +16524,9 @@ } }, "@babel/eslint-parser": { - "version": "7.17.0", - "resolved": "https://registry.npmjs.org/@babel/eslint-parser/-/eslint-parser-7.17.0.tgz", - "integrity": "sha512-PUEJ7ZBXbRkbq3qqM/jZ2nIuakUBqCYc7Qf52Lj7dlZ6zERnqisdHioL0l4wwQZnmskMeasqUNzLBFKs3nylXA==", + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/@babel/eslint-parser/-/eslint-parser-7.18.2.tgz", + "integrity": "sha512-oFQYkE8SuH14+uR51JVAmdqwKYXGRjEXx7s+WiagVjqQ+HPE+nnwyF2qlVG8evUsUHmPcA+6YXMEDbIhEyQc5A==", "dev": true, "requires": { "eslint-scope": "^5.1.1", @@ -16497,14 +16549,14 @@ } }, "@babel/generator": { - "version": "7.17.7", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.17.7.tgz", - "integrity": "sha512-oLcVCTeIFadUoArDTwpluncplrYBmTCCZZgXCbgNGvOBBiSDDK3eWO4b/+eOTli5tKv1lg+a5/NAXg+nTcei1w==", + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.18.2.tgz", + "integrity": "sha512-W1lG5vUwFvfMd8HVXqdfbuG7RuaSrTCCD8cl8fP8wOivdbtbIg2Db3IWUcgvfxKbbn6ZBGYRW/Zk1MIwK49mgw==", "dev": true, "requires": { - "@babel/types": "^7.17.0", - "jsesc": "^2.5.1", - "source-map": "^0.5.0" + "@babel/types": "^7.18.2", + "@jridgewell/gen-mapping": "^0.3.0", + "jsesc": "^2.5.1" } }, "@babel/helper-annotate-as-pure": { @@ -16547,15 +16599,15 @@ } }, "@babel/helper-create-class-features-plugin": { - "version": "7.17.6", - "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.17.6.tgz", - "integrity": "sha512-SogLLSxXm2OkBbSsHZMM4tUi8fUzjs63AT/d0YQIzr6GSd8Hxsbk2KYDX0k0DweAzGMj/YWeiCsorIdtdcW8Eg==", + "version": "7.18.0", + "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.18.0.tgz", + "integrity": "sha512-Kh8zTGR9de3J63e5nS0rQUdRs/kbtwoeQQ0sriS0lItjC96u8XXZN6lKpuyWd2coKSU13py/y+LTmThLuVX0Pg==", "dev": true, "requires": { "@babel/helper-annotate-as-pure": "^7.16.7", "@babel/helper-environment-visitor": "^7.16.7", - "@babel/helper-function-name": "^7.16.7", - "@babel/helper-member-expression-to-functions": "^7.16.7", + "@babel/helper-function-name": "^7.17.9", + "@babel/helper-member-expression-to-functions": "^7.17.7", "@babel/helper-optimise-call-expression": "^7.16.7", "@babel/helper-replace-supers": "^7.16.7", "@babel/helper-split-export-declaration": "^7.16.7" @@ -16596,13 +16648,10 @@ } }, "@babel/helper-environment-visitor": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/helper-environment-visitor/-/helper-environment-visitor-7.16.7.tgz", - "integrity": "sha512-SLLb0AAn6PkUeAfKJCCOl9e1R53pQlGAfc4y4XuMRZfqeMYLE0dM1LMhqbGAlGQY0lfw5/ohoYWAe9V1yibRag==", - "dev": true, - "requires": { - "@babel/types": "^7.16.7" - } + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/@babel/helper-environment-visitor/-/helper-environment-visitor-7.18.2.tgz", + "integrity": "sha512-14GQKWkX9oJzPiQQ7/J36FTXcD4kSp8egKjO9nINlSKiHITRA9q/R74qu8S9xlc/b/yjsJItQUeeh3xnGN0voQ==", + "dev": true }, "@babel/helper-explode-assignable-expression": { "version": "7.16.7", @@ -16614,23 +16663,13 @@ } }, "@babel/helper-function-name": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.16.7.tgz", - "integrity": "sha512-QfDfEnIUyyBSR3HtrtGECuZ6DAyCkYFp7GHl75vFtTnn6pjKeK0T1DB5lLkFvBea8MdaiUABx3osbgLyInoejA==", + "version": "7.17.9", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.17.9.tgz", + "integrity": "sha512-7cRisGlVtiVqZ0MW0/yFB4atgpGLWEHUVYnb448hZK4x+vih0YO5UoS11XIYtZYqHd0dIPMdUSv8q5K4LdMnIg==", "dev": true, "requires": { - "@babel/helper-get-function-arity": "^7.16.7", "@babel/template": "^7.16.7", - "@babel/types": "^7.16.7" - } - }, - "@babel/helper-get-function-arity": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.16.7.tgz", - "integrity": "sha512-flc+RLSOBXzNzVhcLu6ujeHUrD6tANAOU5ojrRx/as+tbzf8+stUCj7+IfRRoAbEZqj/ahXEMsjhOhgeZsrnTw==", - "dev": true, - "requires": { - "@babel/types": "^7.16.7" + "@babel/types": "^7.17.0" } }, "@babel/helper-hoist-variables": { @@ -16686,9 +16725,9 @@ } }, "@babel/helper-plugin-utils": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.16.7.tgz", - "integrity": "sha512-Qg3Nk7ZxpgMrsox6HreY1ZNKdBq7K72tDSliA6dCl5f007jR4ne8iD5UzuNnCJH2xBf2BEEVGr+/OL6Gdp7RxA==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.17.12.tgz", + "integrity": "sha512-JDkf04mqtN3y4iAbO1hv9U2ARpPyPL1zqyWs/2WG1pgSq9llHFjStX5jdxb84himgJm+8Ng+x0oiWF/nw/XQKA==", "dev": true }, "@babel/helper-remap-async-to-generator": { @@ -16703,16 +16742,16 @@ } }, "@babel/helper-replace-supers": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.16.7.tgz", - "integrity": "sha512-y9vsWilTNaVnVh6xiJfABzsNpgDPKev9HnAgz6Gb1p6UUwf9NepdlsV7VXGCftJM+jqD5f7JIEubcpLjZj5dBw==", + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.18.2.tgz", + "integrity": "sha512-XzAIyxx+vFnrOxiQrToSUOzUOn0e1J2Li40ntddek1Y69AXUTXoDJ40/D5RdjFu7s7qHiaeoTiempZcbuVXh2Q==", "dev": true, "requires": { - "@babel/helper-environment-visitor": "^7.16.7", - "@babel/helper-member-expression-to-functions": "^7.16.7", + "@babel/helper-environment-visitor": "^7.18.2", + "@babel/helper-member-expression-to-functions": "^7.17.7", "@babel/helper-optimise-call-expression": "^7.16.7", - "@babel/traverse": "^7.16.7", - "@babel/types": "^7.16.7" + "@babel/traverse": "^7.18.2", + "@babel/types": "^7.18.2" } }, "@babel/helper-simple-access": { @@ -16789,9 +16828,9 @@ } }, "@babel/parser": { - "version": "7.17.8", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.17.8.tgz", - "integrity": "sha512-BoHhDJrJXqcg+ZL16Xv39H9n+AqJ4pcDrQBGZN+wHxIysrLZ3/ECwCBUch/1zUNhnsXULcONU3Ei5Hmkfk6kiQ==", + "version": "7.18.5", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.18.5.tgz", + "integrity": "sha512-YZWVaglMiplo7v8f1oMQ5ZPQr0vn7HPeZXxXWsxXJRjGVrzUFn9OxFQl1sb5wzfootjA/yChhW84BV+383FSOw==", "dev": true }, "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": { @@ -16847,15 +16886,16 @@ } }, "@babel/plugin-proposal-decorators": { - "version": "7.17.8", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-decorators/-/plugin-proposal-decorators-7.17.8.tgz", - "integrity": "sha512-U69odN4Umyyx1xO1rTII0IDkAEC+RNlcKXtqOblfpzqy1C+aOplb76BQNq0+XdpVkOaPlpEDwd++joY8FNFJKA==", + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-decorators/-/plugin-proposal-decorators-7.18.2.tgz", + "integrity": "sha512-kbDISufFOxeczi0v4NQP3p5kIeW6izn/6klfWBrIIdGZZe4UpHR+QU03FAoWjGGd9SUXAwbw2pup1kaL4OQsJQ==", "dev": true, "requires": { - "@babel/helper-create-class-features-plugin": "^7.17.6", - "@babel/helper-plugin-utils": "^7.16.7", - "@babel/helper-replace-supers": "^7.16.7", - "@babel/plugin-syntax-decorators": "^7.17.0", + "@babel/helper-create-class-features-plugin": "^7.18.0", + "@babel/helper-plugin-utils": "^7.17.12", + "@babel/helper-replace-supers": "^7.18.2", + "@babel/helper-split-export-declaration": "^7.16.7", + "@babel/plugin-syntax-decorators": "^7.17.12", "charcodes": "^0.2.0" } }, @@ -17022,12 +17062,12 @@ } }, "@babel/plugin-syntax-decorators": { - "version": "7.17.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-decorators/-/plugin-syntax-decorators-7.17.0.tgz", - "integrity": "sha512-qWe85yCXsvDEluNP0OyeQjH63DlhAR3W7K9BxxU1MvbDb48tgBG+Ao6IJJ6smPDrrVzSQZrbF6donpkFBMcs3A==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-decorators/-/plugin-syntax-decorators-7.17.12.tgz", + "integrity": "sha512-D1Hz0qtGTza8K2xGyEdVNCYLdVHukAcbQr4K3/s6r/esadyEriZovpJimQOpu8ju4/jV8dW/1xdaE0UpDroidw==", "dev": true, "requires": { - "@babel/helper-plugin-utils": "^7.16.7" + "@babel/helper-plugin-utils": "^7.17.12" } }, "@babel/plugin-syntax-dynamic-import": { @@ -17049,12 +17089,12 @@ } }, "@babel/plugin-syntax-flow": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-flow/-/plugin-syntax-flow-7.16.7.tgz", - "integrity": "sha512-UDo3YGQO0jH6ytzVwgSLv9i/CzMcUjbKenL67dTrAZPPv6GFAtDhe6jqnvmoKzC/7htNTohhos+onPtDMqJwaQ==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-flow/-/plugin-syntax-flow-7.17.12.tgz", + "integrity": "sha512-B8QIgBvkIG6G2jgsOHQUist7Sm0EBLDCx8sen072IwqNuzMegZNXrYnSv77cYzA8mLDZAfQYqsLIhimiP1s2HQ==", "dev": true, "requires": { - "@babel/helper-plugin-utils": "^7.16.7" + "@babel/helper-plugin-utils": "^7.17.12" } }, "@babel/plugin-syntax-import-meta": { @@ -17076,12 +17116,12 @@ } }, "@babel/plugin-syntax-jsx": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.16.7.tgz", - "integrity": "sha512-Esxmk7YjA8QysKeT3VhTXvF6y77f/a91SIs4pWb4H2eWGQkCKFgQaG6hdoEVZtGsrAcb2K5BW66XsOErD4WU3Q==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.17.12.tgz", + "integrity": "sha512-spyY3E3AURfxh/RHtjx5j6hs8am5NbUBGfcZ2vB3uShSpZdQyXSf5rR5Mk76vbtlAZOelyVQ71Fg0x9SG4fsog==", "dev": true, "requires": { - "@babel/helper-plugin-utils": "^7.16.7" + "@babel/helper-plugin-utils": "^7.17.12" } }, "@babel/plugin-syntax-logical-assignment-operators": { @@ -17267,13 +17307,13 @@ } }, "@babel/plugin-transform-flow-strip-types": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-flow-strip-types/-/plugin-transform-flow-strip-types-7.16.7.tgz", - "integrity": "sha512-mzmCq3cNsDpZZu9FADYYyfZJIOrSONmHcop2XEKPdBNMa4PDC4eEvcOvzZaCNcjKu72v0XQlA5y1g58aLRXdYg==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-flow-strip-types/-/plugin-transform-flow-strip-types-7.17.12.tgz", + "integrity": "sha512-g8cSNt+cHCpG/uunPQELdq/TeV3eg1OLJYwxypwHtAWo9+nErH3lQx9CSO2uI9lF74A0mR0t4KoMjs1snSgnTw==", "dev": true, "requires": { - "@babel/helper-plugin-utils": "^7.16.7", - "@babel/plugin-syntax-flow": "^7.16.7" + "@babel/helper-plugin-utils": "^7.17.12", + "@babel/plugin-syntax-flow": "^7.17.12" } }, "@babel/plugin-transform-for-of": { @@ -17416,16 +17456,16 @@ } }, "@babel/plugin-transform-react-jsx": { - "version": "7.17.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.17.3.tgz", - "integrity": "sha512-9tjBm4O07f7mzKSIlEmPdiE6ub7kfIe6Cd+w+oQebpATfTQMAgW+YOuWxogbKVTulA+MEO7byMeIUtQ1z+z+ZQ==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.17.12.tgz", + "integrity": "sha512-Lcaw8bxd1DKht3thfD4A12dqo1X16he1Lm8rIv8sTwjAYNInRS1qHa9aJoqvzpscItXvftKDCfaEQzwoVyXpEQ==", "dev": true, "requires": { "@babel/helper-annotate-as-pure": "^7.16.7", "@babel/helper-module-imports": "^7.16.7", - "@babel/helper-plugin-utils": "^7.16.7", - "@babel/plugin-syntax-jsx": "^7.16.7", - "@babel/types": "^7.17.0" + "@babel/helper-plugin-utils": "^7.17.12", + "@babel/plugin-syntax-jsx": "^7.17.12", + "@babel/types": "^7.17.12" } }, "@babel/plugin-transform-react-jsx-development": { @@ -17438,13 +17478,13 @@ } }, "@babel/plugin-transform-react-pure-annotations": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.16.7.tgz", - "integrity": "sha512-hs71ToC97k3QWxswh2ElzMFABXHvGiJ01IB1TbYQDGeWRKWz/MPUTh5jGExdHvosYKpnJW5Pm3S4+TA3FyX+GA==", + "version": "7.18.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.18.0.tgz", + "integrity": "sha512-6+0IK6ouvqDn9bmEG7mEyF/pwlJXVj5lwydybpyyH3D0A7Hftk+NCTdYjnLNZksn261xaOV5ksmp20pQEmc2RQ==", "dev": true, "requires": { "@babel/helper-annotate-as-pure": "^7.16.7", - "@babel/helper-plugin-utils": "^7.16.7" + "@babel/helper-plugin-utils": "^7.17.12" } }, "@babel/plugin-transform-regenerator": { @@ -17667,15 +17707,15 @@ } }, "@babel/preset-react": { - "version": "7.16.7", - "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.16.7.tgz", - "integrity": "sha512-fWpyI8UM/HE6DfPBzD8LnhQ/OcH8AgTaqcqP2nGOXEUV+VKBR5JRN9hCk9ai+zQQ57vtm9oWeXguBCPNUjytgA==", + "version": "7.17.12", + "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.17.12.tgz", + "integrity": "sha512-h5U+rwreXtZaRBEQhW1hOJLMq8XNJBQ/9oymXiCXTuT/0uOwpbT0gUt+sXeOqoXBgNuUKI7TaObVwoEyWkpFgA==", "dev": true, "requires": { - "@babel/helper-plugin-utils": "^7.16.7", + "@babel/helper-plugin-utils": "^7.17.12", "@babel/helper-validator-option": "^7.16.7", "@babel/plugin-transform-react-display-name": "^7.16.7", - "@babel/plugin-transform-react-jsx": "^7.16.7", + "@babel/plugin-transform-react-jsx": "^7.17.12", "@babel/plugin-transform-react-jsx-development": "^7.16.7", "@babel/plugin-transform-react-pure-annotations": "^7.16.7" } @@ -17721,27 +17761,27 @@ } }, "@babel/traverse": { - "version": "7.17.3", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.17.3.tgz", - "integrity": "sha512-5irClVky7TxRWIRtxlh2WPUUOLhcPN06AGgaQSB8AEwuyEBgJVuJ5imdHm5zxk8w0QS5T+tDfnDxAlhWjpb7cw==", + "version": "7.18.5", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.18.5.tgz", + "integrity": "sha512-aKXj1KT66sBj0vVzk6rEeAO6Z9aiiQ68wfDgge3nHhA/my6xMM/7HGQUNumKZaoa2qUPQ5whJG9aAifsxUKfLA==", "dev": true, "requires": { "@babel/code-frame": "^7.16.7", - "@babel/generator": "^7.17.3", - "@babel/helper-environment-visitor": "^7.16.7", - "@babel/helper-function-name": "^7.16.7", + "@babel/generator": "^7.18.2", + "@babel/helper-environment-visitor": "^7.18.2", + "@babel/helper-function-name": "^7.17.9", "@babel/helper-hoist-variables": "^7.16.7", "@babel/helper-split-export-declaration": "^7.16.7", - "@babel/parser": "^7.17.3", - "@babel/types": "^7.17.0", + "@babel/parser": "^7.18.5", + "@babel/types": "^7.18.4", "debug": "^4.1.0", "globals": "^11.1.0" } }, "@babel/types": { - "version": "7.17.0", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.17.0.tgz", - "integrity": "sha512-TmKSNO4D5rzhL5bjWFcVHHLETzfQ/AmbKpKPOSjlP0WoHZ6L911fgoOKY4Alp/emzG4cHJdyN49zpgkbXFEHHw==", + "version": "7.18.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.18.4.tgz", + "integrity": "sha512-ThN1mBcMq5pG/Vm2IcBmPPfyPXbd8S02rS+OBIDENdufvqC7Z/jHPCv9IcP01277aKtDI8g/2XysBN4hA8niiw==", "dev": true, "requires": { "@babel/helper-validator-identifier": "^7.16.7", @@ -19352,9 +19392,9 @@ } }, "@rushstack/eslint-patch": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/@rushstack/eslint-patch/-/eslint-patch-1.1.1.tgz", - "integrity": "sha512-BUyKJGdDWqvWC5GEhyOiUrGNi9iJUr4CU0O2WxJL6QJhHeeA/NVBalH+FeK0r/x/W0rPymXt5s78TDS7d6lCwg==", + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@rushstack/eslint-patch/-/eslint-patch-1.1.3.tgz", + "integrity": "sha512-WiBSI6JBIhC6LRIsB2Kwh8DsGTlbBU+mLRxJmAe3LjHTdkDpwIbEOZgoXBbZilk/vlfjK8i6nKRAvIRn1XaIMw==", "dev": true }, "@rushstack/node-core-library": { @@ -19967,12 +20007,12 @@ "dev": true }, "@yext/eslint-config-slapshot": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/@yext/eslint-config-slapshot/-/eslint-config-slapshot-0.2.0.tgz", - "integrity": "sha512-6j2N/XXnl6inGg/VVEFXC1Kf4QdVNHHTxWG7F7R0xcK8pB2NMOyk23MLiVHNyin2R3xHzj29h7MmWBATsRCIWg==", + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/@yext/eslint-config-slapshot/-/eslint-config-slapshot-0.4.0.tgz", + "integrity": "sha512-YxZ4KRbgjlW0i1oTLL0czHv32hPx+FMRIYOXowqns9JCa04R6FtMjukGzD1xM5OaWklk7px+vJX0PpYV/VIIIw==", "dev": true, "requires": { - "eslint-config-react-app": "^7.0.0" + "eslint-config-react-app": "^7.0.1" } }, "@yext/eslint-plugin-export-star": { @@ -20161,14 +20201,14 @@ "dev": true }, "array-includes": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.4.tgz", - "integrity": "sha512-ZTNSQkmWumEbiHO2GF4GmWxYVTiQyJy2XOTa15sdQSrvKn7l+180egQMqlrMOUMCyLMD7pmyQe4mMDUT6Behrw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.5.tgz", + "integrity": "sha512-iSDYZMMyTPkiFasVqfuAQnWAYcvO/SeBSCGKePoEthjp4LEMTe4uLc7b025o4jAZpHhihh8xPo99TNWUWWkGDQ==", "dev": true, "requires": { "call-bind": "^1.0.2", - "define-properties": "^1.1.3", - "es-abstract": "^1.19.1", + "define-properties": "^1.1.4", + "es-abstract": "^1.19.5", "get-intrinsic": "^1.1.1", "is-string": "^1.0.7" } @@ -20197,14 +20237,15 @@ } }, "array.prototype.flatmap": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.2.5.tgz", - "integrity": "sha512-08u6rVyi1Lj7oqWbS9nUxliETrtIROT4XGTA4D/LWGten6E3ocm7cy9SIrmNHOL5XVbVuckUp3X6Xyg8/zpvHA==", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.0.tgz", + "integrity": "sha512-PZC9/8TKAIxcWKdyeb77EzULHPrIX/tIZebLJUQOMR1OwYosT8yggdfWScfTBCDj5utONvOuPQQumYsU2ULbkg==", "dev": true, "requires": { - "call-bind": "^1.0.0", + "call-bind": "^1.0.2", "define-properties": "^1.1.3", - "es-abstract": "^1.19.0" + "es-abstract": "^1.19.2", + "es-shim-unscopables": "^1.0.0" } }, "asap": { @@ -20222,7 +20263,7 @@ "ast-types-flow": { "version": "0.0.7", "resolved": "https://registry.npmjs.org/ast-types-flow/-/ast-types-flow-0.0.7.tgz", - "integrity": "sha1-9wtzXGvKGlycItmCw+Oef+ujva0=", + "integrity": "sha512-eBvWn1lvIApYMhzQMsu9ciLfkBY499mFZlNqG+/9WR7PVlroQw0vG30cOQQbaKz3sCEc44TAOu2ykzqXSNnwag==", "dev": true }, "asynckit": { @@ -20238,9 +20279,9 @@ "dev": true }, "axe-core": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.4.1.tgz", - "integrity": "sha512-gd1kmb21kwNuWr6BQz8fv6GNECPBnUasepcoLbekws23NVBLODdsClRZ+bQ8+9Uomf3Sm3+Vwn0oYG9NvwnJCw==", + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.4.2.tgz", + "integrity": "sha512-LVAaGp/wkkgYJcjmHsoKx4juT1aQvJyPcW09MLCjVTh3V2cc6PnyempiLMNH5iMdfIX/zdbjUx2KDjMLCTdPeA==", "dev": true }, "axobject-query": { @@ -21093,12 +21134,13 @@ } }, "define-properties": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", - "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.4.tgz", + "integrity": "sha512-uckOqKcfaVvtBdsVkdPv3XjveQJsNQqmhXgRi8uhvWWuPYZCNlzT8qAyblUgNoXdHdjMTzAqeGjAoli8f+bzPA==", "dev": true, "requires": { - "object-keys": "^1.0.12" + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" } }, "define-property": { @@ -21243,31 +21285,34 @@ } }, "es-abstract": { - "version": "1.19.1", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.19.1.tgz", - "integrity": "sha512-2vJ6tjA/UfqLm2MPs7jxVybLoB8i1t1Jd9R3kISld20sIxPcTbLuggQOUxeWeAvIUkduv/CfMjuh4WmiXr2v9w==", + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.20.1.tgz", + "integrity": "sha512-WEm2oBhfoI2sImeM4OF2zE2V3BYdSF+KnSi9Sidz51fQHd7+JuF8Xgcj9/0o+OWeIeIS/MiuNnlruQrJf16GQA==", "dev": true, "requires": { "call-bind": "^1.0.2", "es-to-primitive": "^1.2.1", "function-bind": "^1.1.1", + "function.prototype.name": "^1.1.5", "get-intrinsic": "^1.1.1", "get-symbol-description": "^1.0.0", "has": "^1.0.3", - "has-symbols": "^1.0.2", + "has-property-descriptors": "^1.0.0", + "has-symbols": "^1.0.3", "internal-slot": "^1.0.3", "is-callable": "^1.2.4", - "is-negative-zero": "^2.0.1", + "is-negative-zero": "^2.0.2", "is-regex": "^1.1.4", - "is-shared-array-buffer": "^1.0.1", + "is-shared-array-buffer": "^1.0.2", "is-string": "^1.0.7", - "is-weakref": "^1.0.1", - "object-inspect": "^1.11.0", + "is-weakref": "^1.0.2", + "object-inspect": "^1.12.0", "object-keys": "^1.1.1", "object.assign": "^4.1.2", - "string.prototype.trimend": "^1.0.4", - "string.prototype.trimstart": "^1.0.4", - "unbox-primitive": "^1.0.1" + "regexp.prototype.flags": "^1.4.3", + "string.prototype.trimend": "^1.0.5", + "string.prototype.trimstart": "^1.0.5", + "unbox-primitive": "^1.0.2" } }, "es-module-lexer": { @@ -21276,6 +21321,15 @@ "integrity": "sha512-1HQ2M2sPtxwnvOvT1ZClHyQDiggdNjURWpY2we6aMKCQiUVxTmVs2UYPLIrD84sS+kMdUwfBSylbJPwNnBrnHQ==", "dev": true }, + "es-shim-unscopables": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.0.0.tgz", + "integrity": "sha512-Jm6GPcCdC30eMLbZ2x8z2WuRwAws3zTBBKuusffYVUrNj/GVSUAZ+xKMaUpfNDR5IbyNA5LJbaecoUVbmUcB1w==", + "dev": true, + "requires": { + "has": "^1.0.3" + } + }, "es-to-primitive": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", @@ -21520,9 +21574,9 @@ "requires": {} }, "eslint-config-react-app": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/eslint-config-react-app/-/eslint-config-react-app-7.0.0.tgz", - "integrity": "sha512-xyymoxtIt1EOsSaGag+/jmcywRuieQoA2JbPCjnw9HukFj9/97aGPoZVFioaotzk1K5Qt9sHO5EutZbkrAXS0g==", + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/eslint-config-react-app/-/eslint-config-react-app-7.0.1.tgz", + "integrity": "sha512-K6rNzvkIeHaTd8m/QEh1Zko0KI7BACWkkneSs6s9cKZC/J27X3eZR6Upt1jkmZ/4FK+XUOPPxMEN7+lbUXfSlA==", "dev": true, "requires": { "@babel/core": "^7.16.0", @@ -21767,25 +21821,25 @@ } }, "eslint-plugin-react": { - "version": "7.29.4", - "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.29.4.tgz", - "integrity": "sha512-CVCXajliVh509PcZYRFyu/BoUEz452+jtQJq2b3Bae4v3xBUWPLCmtmBM+ZinG4MzwmxJgJ2M5rMqhqLVn7MtQ==", + "version": "7.30.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.30.0.tgz", + "integrity": "sha512-RgwH7hjW48BleKsYyHK5vUAvxtE9SMPDKmcPRQgtRCYaZA0XQPt5FSkrU3nhz5ifzMZcA8opwmRJ2cmOO8tr5A==", "dev": true, "requires": { - "array-includes": "^3.1.4", - "array.prototype.flatmap": "^1.2.5", + "array-includes": "^3.1.5", + "array.prototype.flatmap": "^1.3.0", "doctrine": "^2.1.0", "estraverse": "^5.3.0", "jsx-ast-utils": "^2.4.1 || ^3.0.0", "minimatch": "^3.1.2", "object.entries": "^1.1.5", "object.fromentries": "^2.0.5", - "object.hasown": "^1.1.0", + "object.hasown": "^1.1.1", "object.values": "^1.1.5", "prop-types": "^15.8.1", "resolve": "^2.0.0-next.3", "semver": "^6.3.0", - "string.prototype.matchall": "^4.0.6" + "string.prototype.matchall": "^4.0.7" }, "dependencies": { "doctrine": { @@ -21804,13 +21858,14 @@ "dev": true }, "resolve": { - "version": "2.0.0-next.3", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.3.tgz", - "integrity": "sha512-W8LucSynKUIDu9ylraa7ueVZ7hc0uAgJBxVsQSKOXOyle8a93qXhcz+XAXZ8bIq2d6i4Ehddn6Evt+0/UwKk6Q==", + "version": "2.0.0-next.4", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.4.tgz", + "integrity": "sha512-iMDbmAWtfU+MHpxt/I5iWI7cY6YVEZUQ3MBgPQ++XD1PELuJHIl82xBmObyP2KyQmkNB2dsqF7seoQQiAn5yDQ==", "dev": true, "requires": { - "is-core-module": "^2.2.0", - "path-parse": "^1.0.6" + "is-core-module": "^2.9.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" } }, "semver": { @@ -21822,9 +21877,9 @@ } }, "eslint-plugin-react-hooks": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-4.3.0.tgz", - "integrity": "sha512-XslZy0LnMn+84NEG9jSGR6eGqaZB3133L8xewQo3fQagbQuGt7a63gf+P1NGKZavEYEC3UXaWEAA/AqDkuN6xA==", + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-4.6.0.tgz", + "integrity": "sha512-oFc7Itz9Qxh2x4gNHStv3BqJq54ExXmfC+a1NjAta66IAN87Wu0R/QArgIS9qKzX3dXKPI9H5crl9QchNMY9+g==", "dev": true, "requires": {} }, @@ -21837,9 +21892,9 @@ "requires": {} }, "eslint-plugin-testing-library": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-testing-library/-/eslint-plugin-testing-library-5.1.0.tgz", - "integrity": "sha512-YSNzasJUbyhOTe14ZPygeOBvcPvcaNkwHwrj4vdf+uirr2D32JTDaKi6CP5Os2aWtOcvt4uBSPXp9h5xGoqvWQ==", + "version": "5.5.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-testing-library/-/eslint-plugin-testing-library-5.5.1.tgz", + "integrity": "sha512-plLEkkbAKBjPxsLj7x4jNapcHAg2ernkQlKKrN2I8NrQwPISZHyCUNvg5Hv3EDqOQReToQb5bnqXYbkijJPE/g==", "dev": true, "requires": { "@typescript-eslint/utils": "^5.13.0" @@ -22517,12 +22572,30 @@ "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", "dev": true }, + "function.prototype.name": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.5.tgz", + "integrity": "sha512-uN7m/BzVKQnCUF/iW8jYea67v++2u7m5UgENbHRtdDVclOUP+FMPlCNdmk0h/ysGyo2tavMJEDqJAkJdRa1vMA==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.0", + "functions-have-names": "^1.2.2" + } + }, "functional-red-black-tree": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", "dev": true }, + "functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true + }, "generate-license-file": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/generate-license-file/-/generate-license-file-1.3.0.tgz", @@ -22656,9 +22729,9 @@ } }, "has-bigints": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", - "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz", + "integrity": "sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ==", "dev": true }, "has-flag": { @@ -22667,6 +22740,15 @@ "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", "dev": true }, + "has-property-descriptors": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.0.tgz", + "integrity": "sha512-62DVLZGoiEBDHQyqG4w9xCuZ7eJEwNmJRWw2VY84Oedb7WFcA27fiEVe8oUQx9hAUJ4ekurquucTGwsyO1XGdQ==", + "dev": true, + "requires": { + "get-intrinsic": "^1.1.1" + } + }, "has-symbols": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", @@ -22998,9 +23080,9 @@ } }, "is-core-module": { - "version": "2.8.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.8.1.tgz", - "integrity": "sha512-SdNCUs284hr40hFTFP6l0IfZ/RSrMXF3qgoRHd3/79unUTvrFO/JoXwkGm+5J/Oe3E/b5GsnG330uUNgRpu1PA==", + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.9.0.tgz", + "integrity": "sha512-+5FPy5PnwmO3lvfMb0AsoPaBG+5KHUI0wYFXOtYPnVVVspTFUuMZNfNaNVRt3FZadstu2c8x23vykRW/NBoU6A==", "dev": true, "requires": { "has": "^1.0.3" @@ -23090,9 +23172,9 @@ "dev": true }, "is-number-object": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.6.tgz", - "integrity": "sha512-bEVOqiRcvo3zO1+G2lVMy+gkkEm9Yh7cDMRusKKu5ZJKPUYSJwICTKZrNKHA2EbSP0Tu0+6B/emsYNHZyn6K8g==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.7.tgz", + "integrity": "sha512-k1U0IRzLMo7ZlYIfzRu23Oh6MiIFasgpb9X76eqfFZAqwH44UI4KTBvBYIZ1dSL9ZzChTB9ShHfLkR4pdW5krQ==", "dev": true, "requires": { "has-tostringtag": "^1.0.0" @@ -23124,10 +23206,13 @@ } }, "is-shared-array-buffer": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.1.tgz", - "integrity": "sha512-IU0NmyknYZN0rChcKhRO1X8LYz5Isj/Fsqh8NJOSf+N/hCOTwy29F32Ik7a+QszE63IdvmwdTPDd6cZ5pg4cwA==", - "dev": true + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.2.tgz", + "integrity": "sha512-sqN2UDu1/0y6uvXyStCOzyhAjCSlHceFoMKJW8W9EU9cvic/QdsZ0kEU93HEy3IUEFZIiH/3w+AH/UQbPHNdhA==", + "dev": true, + "requires": { + "call-bind": "^1.0.2" + } }, "is-stream": { "version": "2.0.0", @@ -25949,9 +26034,9 @@ } }, "jsx-ast-utils": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.2.2.tgz", - "integrity": "sha512-HDAyJ4MNQBboGpUnHAVUNJs6X0lh058s6FuixsFGP7MgJYpD6Vasd6nzSG5iIfXu1zAYlHJ/zsOKNlrenTUBnw==", + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.3.0.tgz", + "integrity": "sha512-XzO9luP6L0xkxwhIJMTJQpZo/eeN60K08jHdexfD569AGxeNug6UketeHXEhROoM8aR7EcUoOQmIhcJQjcuq8Q==", "dev": true, "requires": { "array-includes": "^3.1.4", @@ -25979,7 +26064,7 @@ "language-tags": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/language-tags/-/language-tags-1.0.5.tgz", - "integrity": "sha1-0yHbxNowuovzAk4ED6XBRmH5GTo=", + "integrity": "sha512-qJhlO9cGXi6hBGKoxEG/sKZDAHD5Hnu9Hs4WbOY3pCWXDhw0N8x1NenNzm2EnNLkLkk7J2SdxAkDSbb6ftT+UQ==", "dev": true, "requires": { "language-subtag-registry": "~0.3.2" @@ -26389,7 +26474,7 @@ "object-assign": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", - "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", + "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", "dev": true }, "object-copy": { @@ -26516,13 +26601,13 @@ } }, "object.hasown": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/object.hasown/-/object.hasown-1.1.0.tgz", - "integrity": "sha512-MhjYRfj3GBlhSkDHo6QmvgjRLXQ2zndabdf3nX0yTyZK9rPfxb6uRpAac8HXNLy1GpqWtZ81Qh4v3uOls2sRAg==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object.hasown/-/object.hasown-1.1.1.tgz", + "integrity": "sha512-LYLe4tivNQzq4JdaWW6WO3HMZZJWzkkH8fnI6EebWl0VZth2wL2Lovm74ep2/gZzlaTdV62JZHEqHQ2yVn8Q/A==", "dev": true, "requires": { - "define-properties": "^1.1.3", - "es-abstract": "^1.19.1" + "define-properties": "^1.1.4", + "es-abstract": "^1.19.5" } }, "object.pick": { @@ -27004,13 +27089,14 @@ } }, "regexp.prototype.flags": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.1.tgz", - "integrity": "sha512-pMR7hBVUUGI7PMA37m2ofIdQCsomVnas+Jn5UPGAHQ+/LlwKm/aTLJHdasmHRzlfeZwHiAOaRSo2rbBDm3nNUQ==", + "version": "1.4.3", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.3.tgz", + "integrity": "sha512-fjggEOO3slI6Wvgjwflkc4NFRCTZAu5CnNfBd5qOMYhWdn67nJBBu34/TkD++eeFmd8C9r9jfXJ27+nSiRkSUA==", "dev": true, "requires": { "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "define-properties": "^1.1.3", + "functions-have-names": "^1.2.2" } }, "regexpp": { @@ -27987,23 +28073,25 @@ } }, "string.prototype.trimend": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", - "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.5.tgz", + "integrity": "sha512-I7RGvmjV4pJ7O3kdf+LXFpVfdNOxtCW/2C8f6jNiW4+PQchwxkCDzlk1/7p+Wl4bqFIZeF47qAHXLuHHWKAxog==", "dev": true, "requires": { "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "define-properties": "^1.1.4", + "es-abstract": "^1.19.5" } }, "string.prototype.trimstart": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", - "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.5.tgz", + "integrity": "sha512-THx16TJCGlsN0o6dl2o6ncWUsdgnLRSA23rRE5pyGBw/mLr3Ej/R2LaqCtgP8VNMGZsvMWnf9ooZPyY2bHvUFg==", "dev": true, "requires": { "call-bind": "^1.0.2", - "define-properties": "^1.1.3" + "define-properties": "^1.1.4", + "es-abstract": "^1.19.5" } }, "strip-ansi": { @@ -28450,14 +28538,14 @@ "dev": true }, "unbox-primitive": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", - "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", + "integrity": "sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==", "dev": true, "requires": { - "function-bind": "^1.1.1", - "has-bigints": "^1.0.1", - "has-symbols": "^1.0.2", + "call-bind": "^1.0.2", + "has-bigints": "^1.0.2", + "has-symbols": "^1.0.3", "which-boxed-primitive": "^1.0.2" } }, diff --git a/package.json b/package.json index 390c99a8..e22ad395 100644 --- a/package.json +++ b/package.json @@ -1,15 +1,27 @@ { - "name": "@yext/answers-core", - "version": "1.7.0", - "description": "Typescript Networking Library for the Yext Answers API", + "name": "@yext/search-core", + "version": "1.8.0", + "description": "Typescript Networking Library for the Yext Search API", "main": "./dist/commonjs/src/index.js", "module": "./dist/esm/src/index.js", "types": "./dist/bundle.d.ts", + "keywords": [ + "networking", + "search api", + "search", + "browser", + "nodejs", + "typescript", + "commonjs", + "es6", + "yext" + ], "files": [ "dist", "legacy", "lib", - "src" + "src", + "THIRD-PARTY-NOTICES" ], "engines": { "node": ">=12" @@ -31,14 +43,14 @@ }, "repository": { "type": "git", - "url": "https://github.com/yext/answers-core.git" + "url": "https://github.com/yext/search-core.git" }, "author": "slapshot@yext.com", "license": "BSD-3-Clause", "bugs": { - "url": "https://github.com/yext/answers-core/issues" + "url": "https://github.com/yext/search-core/issues" }, - "homepage": "https://github.com/yext/answers-core#readme", + "homepage": "https://github.com/yext/search-core#readme", "devDependencies": { "@babel/core": "^7.12.3", "@babel/plugin-transform-runtime": "^7.12.10", @@ -49,12 +61,12 @@ "@types/jest": "^28.1.1", "@typescript-eslint/eslint-plugin": "^5.16.0", "@typescript-eslint/parser": "^5.16.0", - "@yext/eslint-config-slapshot": "^0.2.0", + "@yext/eslint-config-slapshot": "^0.4.0", "@yext/eslint-plugin-export-star": "^1.0.2", "babel-jest": "^26.6.1", "babel-loader": "^8.2.2", "eslint": "^8.11.0", - "eslint-config-react-app": "^7.0.0", + "eslint-config-react-app": "^7.0.1", "eslint-plugin-tsdoc": "^0.2.14", "generate-license-file": "^1.3.0", "jest": "^28.1.0", diff --git a/src/AnswersCore.ts b/src/SearchCore.ts similarity index 86% rename from src/AnswersCore.ts rename to src/SearchCore.ts index 2d6577e4..3751b17d 100644 --- a/src/AnswersCore.ts +++ b/src/SearchCore.ts @@ -17,7 +17,7 @@ import { AutocompleteService } from './services/AutocompleteService'; * * @public */ -export class AnswersCore { +export class SearchCore { constructor( private searchService: SearchService, private questionSubmissionService: QuestionSubmissionService, @@ -25,10 +25,10 @@ export class AnswersCore { ) {} /** - * Performs an Answers search across all verticals. + * Performs a search across all verticals. * * @remarks - * If rejected, the reason will be an {@link AnswersError}. + * If rejected, the reason will be an {@link SearchError}. * * @param request - Universal search request options */ @@ -37,10 +37,10 @@ export class AnswersCore { } /** - * Performs an Answers search for a single vertical. + * Performs a search for a single vertical. * * @remarks - * If rejected, the reason will be an {@link AnswersError}. + * If rejected, the reason will be an {@link SearchError}. * * @param request - Vertical search request options */ @@ -49,10 +49,10 @@ export class AnswersCore { } /** - * Submits a custom question to the Answers API. + * Submits a custom question to the Search API. * * @remarks - * If rejected, the reason will be an {@link AnswersError}. + * If rejected, the reason will be an {@link SearchError}. * * @param request - Question submission request options */ @@ -64,7 +64,7 @@ export class AnswersCore { * Performs an autocomplete request across all verticals. * * @remarks - * If rejected, the reason will be an {@link AnswersError}. + * If rejected, the reason will be an {@link SearchError}. * * @param request - Universal autocomplete request options */ @@ -76,7 +76,7 @@ export class AnswersCore { * Performs an autocomplete request for a single vertical. * * @remarks - * If rejected, the reason will be an {@link AnswersError}. + * If rejected, the reason will be an {@link SearchError}. * * @param request - Vertical autocomplete request options */ @@ -90,7 +90,7 @@ export class AnswersCore { * @remarks * This differs from the vertical autocomplete because the vertical autocomplete * operates on all entity fields whereas filtersearch operates only on specified fields. - * If rejected, the reason will be an {@link AnswersError}. + * If rejected, the reason will be an {@link SearchError}. * * @example * A site has a 'products' vertical and would like a way to allow the user to narrow down diff --git a/src/deprecated.ts b/src/deprecated.ts new file mode 100644 index 00000000..7b965448 --- /dev/null +++ b/src/deprecated.ts @@ -0,0 +1,7 @@ +import { SearchCore } from './SearchCore'; + +/** + * @deprecated AnswersCore is deprecated and has been replaced by {@link SearchCore} + * @public + */ +export class AnswersCore extends SearchCore{} \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index 452e19a8..8862474c 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,4 +1,8 @@ -export { AnswersCore } from './AnswersCore'; +// deprecated symbols +export { AnswersCore } from './deprecated'; + +// main symbols +export { SearchCore } from './SearchCore'; export { provideCore } from './provideCore'; export { SandboxEndpoints } from './constants'; export * from './models'; diff --git a/src/infra/AutocompleteServiceImpl.ts b/src/infra/AutocompleteServiceImpl.ts index 29f04ffe..6068ebde 100644 --- a/src/infra/AutocompleteServiceImpl.ts +++ b/src/infra/AutocompleteServiceImpl.ts @@ -6,12 +6,12 @@ import { } from '../models/autocompleteservice/AutocompleteRequest'; import { AutocompleteResponse, FilterSearchResponse } from '../models/autocompleteservice/AutocompleteResponse'; import { defaultApiVersion } from '../constants'; -import { AnswersConfigWithDefaulting } from '../models/core/AnswersConfig'; +import { SearchConfigWithDefaulting } from '../models/core/SearchConfig'; import { HttpService } from '../services/HttpService'; import { AutocompleteQueryParams } from '../models/autocompleteservice/AutocompleteQueryParams'; import { AutocompleteService } from '../services/AutocompleteService'; import { ApiResponseValidator } from '../validation/ApiResponseValidator'; -import { ApiResponse } from '../models/answersapi/ApiResponse'; +import { ApiResponse } from '../models/searchapi/ApiResponse'; import { getClientSdk } from '../utils/getClientSdk'; import { serializeExcludedFields, serializeSearchParameterFields } from '../serializers/serializeFilterSearch'; @@ -37,7 +37,7 @@ interface FilterSearchQueryParams extends AutocompleteQueryParams { * A service that performs query suggestions. */ export class AutocompleteServiceImpl implements AutocompleteService { - private config: AnswersConfigWithDefaulting; + private config: SearchConfigWithDefaulting; private httpService: HttpService; private apiResponseValidator; private universalEndpoint: string; @@ -45,7 +45,7 @@ export class AutocompleteServiceImpl implements AutocompleteService { private filterEndpoint: string; constructor( - config: AnswersConfigWithDefaulting, + config: SearchConfigWithDefaulting, httpRequester: HttpService, apiResponseValidator: ApiResponseValidator ) { diff --git a/src/infra/QuestionSubmissionServiceImpl.ts b/src/infra/QuestionSubmissionServiceImpl.ts index ce492863..5609da1d 100644 --- a/src/infra/QuestionSubmissionServiceImpl.ts +++ b/src/infra/QuestionSubmissionServiceImpl.ts @@ -1,11 +1,11 @@ import { defaultApiVersion } from '../constants'; import { QuestionSubmissionService } from '../services/QuestionSubmissionService'; import { HttpService } from '../services/HttpService'; -import { AnswersConfigWithDefaulting } from '../models/core/AnswersConfig'; +import { SearchConfigWithDefaulting } from '../models/core/SearchConfig'; import { QuestionSubmissionRequest } from '../models/questionsubmission/QuestionSubmissionRequest'; import { QuestionSubmissionResponse } from '../models/questionsubmission/QuestionSubmissionResponse'; import { ApiResponseValidator } from '../validation/ApiResponseValidator'; -import { ApiResponse } from '../models/answersapi/ApiResponse'; +import { ApiResponse } from '../models/searchapi/ApiResponse'; import { getClientSdk } from '../utils/getClientSdk'; /** @@ -14,13 +14,13 @@ import { getClientSdk } from '../utils/getClientSdk'; * @internal */ export class QuestionSubmissionServiceImpl implements QuestionSubmissionService { - private config: AnswersConfigWithDefaulting; + private config: SearchConfigWithDefaulting; private httpService: HttpService; private apiResponseValidator: ApiResponseValidator; private endpoint: string; constructor( - config: AnswersConfigWithDefaulting, + config: SearchConfigWithDefaulting, httpService: HttpService, apiResponseValidator: ApiResponseValidator ) { diff --git a/src/infra/SearchServiceImpl.ts b/src/infra/SearchServiceImpl.ts index ee2e8efc..2f0411d2 100644 --- a/src/infra/SearchServiceImpl.ts +++ b/src/infra/SearchServiceImpl.ts @@ -8,13 +8,13 @@ import { UniversalSearchRequest } from '../models/searchservice/request/Universa import { UniversalSearchResponse } from '../models/searchservice/response/UniversalSearchResponse'; import { createUniversalSearchResponse } from '../transformers/searchservice/createUniversalSearchResponse'; import { HttpService } from '../services/HttpService'; -import { AnswersConfigWithDefaulting } from '../models/core/AnswersConfig'; +import { SearchConfigWithDefaulting } from '../models/core/SearchConfig'; import { VerticalSearchRequest } from '../models/searchservice/request/VerticalSearchRequest'; import { VerticalSearchResponse } from '../models/searchservice/response/VerticalSearchResponse'; import { serializeStaticFilters } from '../serializers/serializeStaticFilters'; import { serializeFacets } from '../serializers/serializeFacets'; import { ApiResponseValidator } from '../validation/ApiResponseValidator'; -import { ApiResponse } from '../models/answersapi/ApiResponse'; +import { ApiResponse } from '../models/searchapi/ApiResponse'; import { LatLong } from '../models/searchservice/request/LatLong'; import { getClientSdk } from '../utils/getClientSdk'; @@ -78,14 +78,14 @@ interface VerticalSearchQueryParams extends QueryParams { * @internal */ export class SearchServiceImpl implements SearchService { - private config: AnswersConfigWithDefaulting; + private config: SearchConfigWithDefaulting; private httpService: HttpService; private apiResponseValidator: ApiResponseValidator; private verticalSearchEndpoint: string; private universalSearchEndpoint: string; constructor( - config: AnswersConfigWithDefaulting, + config: SearchConfigWithDefaulting, httpService: HttpService, apiResponseValidator: ApiResponseValidator ) { @@ -115,7 +115,7 @@ export class SearchServiceImpl implements SearchService { source: request.querySource || QuerySource.Standard, visitorId: this.config.visitor?.id, visitorIdMethod: this.config.visitor?.idMethod, - restrictVerticals: request.restrictVerticals && request.restrictVerticals.join(','), + restrictVerticals: request.restrictVerticals?.join(','), ...this.config?.additionalQueryParams }; @@ -192,7 +192,7 @@ export class SearchServiceImpl implements SearchService { } /** - * Converts a {@link LatLong} into the format the Answers API expects. + * Converts a {@link LatLong} into the format the Search API expects. */ private stringifyLatLong(latLong: LatLong | undefined): string | undefined { if (!latLong) { diff --git a/src/models/autocompleteservice/AutocompleteRequest.ts b/src/models/autocompleteservice/AutocompleteRequest.ts index d7976824..15a3e4db 100644 --- a/src/models/autocompleteservice/AutocompleteRequest.ts +++ b/src/models/autocompleteservice/AutocompleteRequest.ts @@ -1,4 +1,4 @@ -import { AnswersRequest } from '../core/AnswersRequest'; +import { SearchRequest } from '../core/SearchRequest'; import { Filter } from '../searchservice/request/Filter'; /** @@ -6,7 +6,7 @@ import { Filter } from '../searchservice/request/Filter'; * * @public */ -export interface UniversalAutocompleteRequest extends AnswersRequest { +export interface UniversalAutocompleteRequest extends SearchRequest { /** The input string for autocomplete. */ input: string, /** Enables session tracking. */ @@ -18,7 +18,7 @@ export interface UniversalAutocompleteRequest extends AnswersRequest { * * @public */ -export interface VerticalAutocompleteRequest extends AnswersRequest { +export interface VerticalAutocompleteRequest extends SearchRequest { /** {@inheritDoc UniversalAutocompleteRequest.input} */ input: string, /** {@inheritDoc UniversalAutocompleteRequest.sessionTrackingEnabled} */ @@ -32,7 +32,7 @@ export interface VerticalAutocompleteRequest extends AnswersRequest { * * @public */ -export interface FilterSearchRequest extends AnswersRequest { +export interface FilterSearchRequest extends SearchRequest { /** {@inheritDoc UniversalAutocompleteRequest.input} */ input: string, /** {@inheritDoc UniversalAutocompleteRequest.sessionTrackingEnabled} */ diff --git a/src/models/autocompleteservice/AutocompleteResponse.ts b/src/models/autocompleteservice/AutocompleteResponse.ts index 7b776951..50b20498 100644 --- a/src/models/autocompleteservice/AutocompleteResponse.ts +++ b/src/models/autocompleteservice/AutocompleteResponse.ts @@ -41,7 +41,7 @@ export interface FilterSearchResponse { /** An array of {@link AutocompleteResult}s. */ results: AutocompleteResult[] }[], - /** ID of the account associated with this Answers experience */ + /** ID of the account associated with this Search experience. */ businessId?: string, /** {@inheritDoc AutocompleteResponse.queryId} */ queryId?: string, diff --git a/src/models/core/AdditionalHttpHeaders.ts b/src/models/core/AdditionalHttpHeaders.ts index 5af8fd46..582b0074 100644 --- a/src/models/core/AdditionalHttpHeaders.ts +++ b/src/models/core/AdditionalHttpHeaders.ts @@ -10,7 +10,7 @@ export interface AdditionalHttpHeaders { } /** - * Additional agents and their versions used to create the Answers experience. The information for these + * 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. * * @public @@ -20,7 +20,7 @@ export interface ClientSDKHeaderValues { [agent: string]: string | undefined, /** * 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. + * header and populated with the version of Search Core being used. */ ANSWERS_CORE?: never } diff --git a/src/models/core/AnswersConfig.ts b/src/models/core/AnswersConfig.ts deleted file mode 100644 index acdbfb75..00000000 --- a/src/models/core/AnswersConfig.ts +++ /dev/null @@ -1,86 +0,0 @@ -import { Endpoints } from './Endpoints'; -import { Visitor } from './Visitor'; - -/** - * The base configuration options for {@link AnswersCore}. - * @public - */ -export interface BaseAnswersConfig { - /** The experience key of the answers experience. */ - experienceKey: string, - /** The locale of the answers experience. */ - locale: string, - /** - * The version of the answers experience configuration. - * - * @remarks - * May be a configuration label (string) or a configuration version (number). - * - * @example - * Examples: 'PRODUCTION', 42 - */ - experienceVersion?: 'STAGING' | 'PRODUCTION' | string | number, - /** {@inheritDoc Visitor} */ - visitor?: Visitor, - /** - * {@inheritDoc Endpoints} - * - * @public - */ - endpoints?: Endpoints, - /** - * Additional query params added on to every request. - * - * @alpha - */ - additionalQueryParams?: { - [key: string]: string | number | boolean - } -} - -/** - * Configuration options for {@link AnswersCore}, which includes the - * options from {@link BaseAnswersConfig}, but requires apiKey. - * @public - */ -export interface AnswersConfigWithApiKey extends BaseAnswersConfig { - /** The api key of the answers experience which will be sent as a query param. */ - apiKey: string, - /** - * token should NOT be provided along with apiKey. - */ - token?: never -} - -/** - * Configuration options for {@link AnswersCore}, which includes the - * options from {@link BaseAnswersConfig}, but requires token. - * @public - */ -export interface AnswersConfigWithToken extends BaseAnswersConfig { - /** - * The authentication token of the answers experience - * which will be passed in the Auth header as a Bearer token. - */ - token: string, - /** - * apiKey should NOT be provided along with token. - */ - apiKey?: never -} - -/** - * The main configuration options for {@link AnswersCore}. - * For a full description of the options, see {@link BaseAnswersConfig}. - * The config requires either an apiKey or a token. - * - * @public - */ -export type AnswersConfig = AnswersConfigWithApiKey | AnswersConfigWithToken; - -/** - * The AnswersConfig after any defaulting has been done from within answers-core. - * - * @internal - */ -export type AnswersConfigWithDefaulting = AnswersConfig & { endpoints: Required }; \ No newline at end of file diff --git a/src/models/core/Endpoints.ts b/src/models/core/Endpoints.ts index 7f3f156b..208c7575 100644 --- a/src/models/core/Endpoints.ts +++ b/src/models/core/Endpoints.ts @@ -1,5 +1,5 @@ /** - * 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. * * @public */ diff --git a/src/models/core/SearchConfig.ts b/src/models/core/SearchConfig.ts new file mode 100644 index 00000000..6a198725 --- /dev/null +++ b/src/models/core/SearchConfig.ts @@ -0,0 +1,86 @@ +import { Endpoints } from './Endpoints'; +import { Visitor } from './Visitor'; + +/** + * The base configuration options for {@link SearchCore}. + * @public + */ +export interface BaseSearchConfig { + /** The experience key of the search experience. */ + experienceKey: string, + /** The locale of the search experience. */ + locale: string, + /** + * The version of the search experience configuration. + * + * @remarks + * May be a configuration label (string) or a configuration version (number). + * + * @example + * Examples: 'PRODUCTION', 42 + */ + experienceVersion?: 'STAGING' | 'PRODUCTION' | string | number, + /** {@inheritDoc Visitor} */ + visitor?: Visitor, + /** + * {@inheritDoc Endpoints} + * + * @public + */ + endpoints?: Endpoints, + /** + * Additional query params added on to every request. + * + * @alpha + */ + additionalQueryParams?: { + [key: string]: string | number | boolean + } +} + +/** + * Configuration options for {@link SearchCore}, which includes the + * options from {@link BaseSearchConfig}, but requires apiKey. + * @public + */ +export interface SearchConfigWithApiKey extends BaseSearchConfig { + /** The api key of the search experience which will be sent as a query param. */ + apiKey: string, + /** + * token should NOT be provided along with apiKey. + */ + token?: never +} + +/** + * Configuration options for {@link SearchCore}, which includes the + * options from {@link BaseSearchConfig}, but requires token. + * @public + */ +export interface SearchConfigWithToken extends BaseSearchConfig { + /** + * The authentication token of the search experience + * which will be passed in the Auth header as a Bearer token. + */ + token: string, + /** + * apiKey should NOT be provided along with token. + */ + apiKey?: never +} + +/** + * The main configuration options for {@link SearchCore}. + * For a full description of the options, see {@link BaseSearchConfig}. + * The config requires either an apiKey or a token. + * + * @public + */ +export type SearchConfig = SearchConfigWithApiKey | SearchConfigWithToken; + +/** + * The SearchConfig after any defaulting has been done from within search-core. + * + * @internal + */ +export type SearchConfigWithDefaulting = SearchConfig & { endpoints: Required }; \ No newline at end of file diff --git a/src/models/core/AnswersRequest.ts b/src/models/core/SearchRequest.ts similarity index 71% rename from src/models/core/AnswersRequest.ts rename to src/models/core/SearchRequest.ts index c079a535..2ba3e304 100644 --- a/src/models/core/AnswersRequest.ts +++ b/src/models/core/SearchRequest.ts @@ -1,11 +1,11 @@ import { AdditionalHttpHeaders } from './AdditionalHttpHeaders'; /** - * Options for an Answers API request. + * Options for a Search API request. * * @public */ -export interface AnswersRequest { +export interface SearchRequest { /** {@inheritDoc AdditionalHttpHeaders} */ additionalHttpHeaders?: AdditionalHttpHeaders } \ No newline at end of file diff --git a/src/models/deprecated.ts b/src/models/deprecated.ts new file mode 100644 index 00000000..839ed26a --- /dev/null +++ b/src/models/deprecated.ts @@ -0,0 +1,43 @@ +/* eslint-disable @typescript-eslint/no-empty-interface */ +import { SearchConfig } from './core/SearchConfig'; +import { BaseSearchConfig } from './core/SearchConfig'; +import { SearchConfigWithApiKey } from './core/SearchConfig'; +import { SearchConfigWithToken } from './core/SearchConfig'; +import { SearchError } from './searchapi/SearchError'; +import { SearchRequest } from './core/SearchRequest'; + +/** + * @deprecated AnswersConfig is deprecated and has been replaced by {@link SearchConfig} + * @public + */ +export type AnswersConfig = SearchConfig; + +/** + * @deprecated BaseAnswersConfig is deprecated and has been replaced by {@link BaseSearchConfig} + * @public + */ +export interface BaseAnswersConfig extends BaseSearchConfig{} + +/** + * @deprecated AnswersConfigWithApiKey is deprecated and has been replaced by {@link SearchConfigWithApiKey} + * @public + */ +export interface AnswersConfigWithApiKey extends SearchConfigWithApiKey{} + +/** + * @deprecated AnswersConfigWithToken is deprecated and has been replaced by {@link SearchConfigWithToken} + * @public + */ +export interface AnswersConfigWithToken extends SearchConfigWithToken{} + +/** + * @deprecated AnswersError is deprecated and has been replaced by {@link SearchError} + * @public + */ +export interface AnswersError extends SearchError{} + +/** +* @deprecated AnswersRequest is deprecated and has been replaced by {@link SearchRequest} +* @public +*/ +export interface AnswersRequest extends SearchRequest{} diff --git a/src/models/index.ts b/src/models/index.ts index 382c056b..e16a746c 100644 --- a/src/models/index.ts +++ b/src/models/index.ts @@ -1,14 +1,22 @@ -// Answers API models -export { AnswersError } from './answersapi/AnswersError'; +// deprecated symbols +export { AnswersConfig } from './deprecated'; +export { BaseAnswersConfig } from './deprecated'; +export { AnswersConfigWithApiKey } from './deprecated'; +export { AnswersConfigWithToken } from './deprecated'; +export { AnswersError } from './deprecated'; +export { AnswersRequest } from './deprecated'; + +// Search API models +export { SearchError } from './searchapi/SearchError'; // Core models export { - AnswersConfig, - BaseAnswersConfig, - AnswersConfigWithApiKey, - AnswersConfigWithToken -} from './core/AnswersConfig'; -export { AnswersRequest } from './core/AnswersRequest'; + SearchConfig, + BaseSearchConfig, + SearchConfigWithApiKey, + SearchConfigWithToken +} from './core/SearchConfig'; +export { SearchRequest } from './core/SearchRequest'; export { Endpoints } from './core/Endpoints'; export { Visitor } from './core/Visitor'; export { diff --git a/src/models/questionsubmission/QuestionSubmissionRequest.ts b/src/models/questionsubmission/QuestionSubmissionRequest.ts index 857e1963..21eed390 100644 --- a/src/models/questionsubmission/QuestionSubmissionRequest.ts +++ b/src/models/questionsubmission/QuestionSubmissionRequest.ts @@ -1,11 +1,11 @@ -import { AnswersRequest } from '../core/AnswersRequest'; +import { SearchRequest } from '../core/SearchRequest'; /** * Options for a QuestionSubmission request. * * @public */ -export interface QuestionSubmissionRequest extends AnswersRequest { +export interface QuestionSubmissionRequest extends SearchRequest { /** The email of the user that is submitting the question. */ email: string, /** The ID of the entity to associate with the question. */ diff --git a/src/models/answersapi/ApiResponse.ts b/src/models/searchapi/ApiResponse.ts similarity index 76% rename from src/models/answersapi/ApiResponse.ts rename to src/models/searchapi/ApiResponse.ts index 710d113b..f4be9eb1 100644 --- a/src/models/answersapi/ApiResponse.ts +++ b/src/models/searchapi/ApiResponse.ts @@ -1,5 +1,5 @@ /** - * The basic structure of a response from the Answers API + * The basic structure of a response from the Search API. * * @internal */ diff --git a/src/models/answersapi/AnswersError.ts b/src/models/searchapi/SearchError.ts similarity index 73% rename from src/models/answersapi/AnswersError.ts rename to src/models/searchapi/SearchError.ts index 69c50ca2..dfb17315 100644 --- a/src/models/answersapi/AnswersError.ts +++ b/src/models/searchapi/SearchError.ts @@ -2,16 +2,16 @@ * Represents an error * * @remarks - * If the error originates from the Answer API, the code and type property will be present. + * If the error originates from the Search API, the code and type property will be present. * * @public */ -export class AnswersError extends Error { +export class SearchError extends Error { /** The error message. */ public message: string; - /** Answers API error code. */ + /** Search API error code. */ public code?: number; - /** Answers API error type. */ + /** Search API error type. */ public type?: string; /** @internal */ @@ -25,6 +25,6 @@ export class AnswersError extends Error { // When targeting ES5, it is necessary to manually set the prototype for instance of checks to work // See: "Extending built-ins like Error, Array, and Map may no longer work" // https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes - Object.setPrototypeOf(this, AnswersError.prototype); + Object.setPrototypeOf(this, SearchError.prototype); } } \ No newline at end of file diff --git a/src/models/searchservice/request/ApiStaticFilters.ts b/src/models/searchservice/request/ApiStaticFilters.ts index a32c2ea7..5f9b13c9 100644 --- a/src/models/searchservice/request/ApiStaticFilters.ts +++ b/src/models/searchservice/request/ApiStaticFilters.ts @@ -1,7 +1,7 @@ import { NearFilterValue } from './Filter'; /** - * Represents static filters in the format that the Answers API expects. + * Represents static filters in the format that the Search API expects. * * @internal */ @@ -10,7 +10,7 @@ export interface ApiStaticFilters { } /** - * Represents a single filter in the format that the Answers API expects. + * Represents a single filter in the format that the Search API expects. * * @internal */ diff --git a/src/models/searchservice/request/Context.ts b/src/models/searchservice/request/Context.ts index 8a8250cd..48ba05dc 100644 --- a/src/models/searchservice/request/Context.ts +++ b/src/models/searchservice/request/Context.ts @@ -1,6 +1,6 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ /** - * Used to trigger Answers + * Used to trigger Search * {@link https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/ | Query Rules}. * * @remarks diff --git a/src/models/searchservice/request/Facet.ts b/src/models/searchservice/request/Facet.ts index 7c5571d8..4e943ab8 100644 --- a/src/models/searchservice/request/Facet.ts +++ b/src/models/searchservice/request/Facet.ts @@ -2,7 +2,7 @@ import { Matcher } from '../common/Matcher'; import { NumberRangeValue } from '../common/NumberRangeValue'; /** - * Represents dynamic filter options for the Answers API. + * Represents dynamic filter options for the Search API. * * @public */ diff --git a/src/models/searchservice/request/QuerySource.ts b/src/models/searchservice/request/QuerySource.ts index 880dcacc..2a3e9470 100644 --- a/src/models/searchservice/request/QuerySource.ts +++ b/src/models/searchservice/request/QuerySource.ts @@ -5,11 +5,11 @@ */ export enum QuerySource { /** - * Indicates that the query was initiated from a standard Answers integration. + * Indicates that the query was initiated from a standard Search integration. */ Standard = 'STANDARD', /** - * Indicates that the query was initiated from an Answers Overlay. + * Indicates that the query was initiated from a Search Overlay. */ Overlay = 'OVERLAY', /** diff --git a/src/models/searchservice/request/QueryTrigger.ts b/src/models/searchservice/request/QueryTrigger.ts index faf51c5e..ea6b1b1d 100644 --- a/src/models/searchservice/request/QueryTrigger.ts +++ b/src/models/searchservice/request/QueryTrigger.ts @@ -5,7 +5,7 @@ * Used for search analytics. If a user supplied the search query, do not include a QueryTrigger. * * @example - * An answers site may be configured to perform a search for 'What services do you offer?' when the page + * A Search site may be configured to perform a search for 'What services do you offer?' when the page * loads. Because that query is a default query rather than a user-supplied query, the Initialize QueryTrigger * should be included in the request. * diff --git a/src/models/searchservice/request/UniversalSearchRequest.ts b/src/models/searchservice/request/UniversalSearchRequest.ts index f08954b2..de9b49d9 100644 --- a/src/models/searchservice/request/UniversalSearchRequest.ts +++ b/src/models/searchservice/request/UniversalSearchRequest.ts @@ -3,14 +3,14 @@ import { LatLong } from './LatLong'; import { QueryTrigger } from './QueryTrigger'; import { QuerySource } from './QuerySource'; import { UniversalLimit } from './UniversalLimit'; -import { AnswersRequest } from '../../core/AnswersRequest'; +import { SearchRequest } from '../../core/SearchRequest'; /** * Options which can be specified for a universal search. * * @public */ -export interface UniversalSearchRequest extends AnswersRequest { +export interface UniversalSearchRequest extends SearchRequest { /** The search query. */ query: string, /** {@inheritDoc QueryTrigger} */ diff --git a/src/models/searchservice/request/VerticalSearchRequest.ts b/src/models/searchservice/request/VerticalSearchRequest.ts index 598a409c..84e1921d 100644 --- a/src/models/searchservice/request/VerticalSearchRequest.ts +++ b/src/models/searchservice/request/VerticalSearchRequest.ts @@ -6,14 +6,14 @@ import { QueryTrigger } from './QueryTrigger'; import { SortBy } from './SortBy'; import { QuerySource } from './QuerySource'; import { Facet } from './Facet'; -import { AnswersRequest } from '../../core/AnswersRequest'; +import { SearchRequest } from '../../core/SearchRequest'; /** * Options which can be specified for a vertical search. * * @public */ -export interface VerticalSearchRequest extends AnswersRequest { +export interface VerticalSearchRequest extends SearchRequest { /** The search query. */ query: string, /** The key associated with the vertical. */ diff --git a/src/models/searchservice/response/AppliedQueryFilter.ts b/src/models/searchservice/response/AppliedQueryFilter.ts index 8209c42f..9b9b71e6 100644 --- a/src/models/searchservice/response/AppliedQueryFilter.ts +++ b/src/models/searchservice/response/AppliedQueryFilter.ts @@ -3,7 +3,7 @@ import { AppliedQueryFilterType } from './AppliedQueryFilterType'; import { LocationFilterDetails } from './LocationFilterDetails'; /** - * A filter that the Answers API applied to the search. + * A filter that the Search API applied to the search. * * @public */ diff --git a/src/models/searchservice/response/HighlightedFields.ts b/src/models/searchservice/response/HighlightedFields.ts index c6b5e187..e3f2e900 100644 --- a/src/models/searchservice/response/HighlightedFields.ts +++ b/src/models/searchservice/response/HighlightedFields.ts @@ -1,7 +1,7 @@ import { HighlightedValue } from './HighlightedValue'; /** - * A mapping of fields to the values emphasized by the Answers API + * A mapping of fields to the values emphasized by the Search API. * * @remarks * Only fields that have been marked as highlighted will be present - which may not be diff --git a/src/models/searchservice/response/HighlightedValue.ts b/src/models/searchservice/response/HighlightedValue.ts index 14759c2f..18a9d369 100644 --- a/src/models/searchservice/response/HighlightedValue.ts +++ b/src/models/searchservice/response/HighlightedValue.ts @@ -1,5 +1,5 @@ /** - * A field value and its substring matches as emphasized by the Answers API. + * A field value and its substring matches as emphasized by the Search API. * * @public */ @@ -9,7 +9,7 @@ export interface HighlightedValue { * * @remarks * No formatting is applied to this value. This is simply the value that - * the Answers API determined should be highlighted. + * the Search API determined should be highlighted. */ value: string, /** diff --git a/src/models/searchservice/response/QueryRulesActionsData.ts b/src/models/searchservice/response/QueryRulesActionsData.ts index 620eca88..e312a7c0 100644 --- a/src/models/searchservice/response/QueryRulesActionsData.ts +++ b/src/models/searchservice/response/QueryRulesActionsData.ts @@ -1,5 +1,5 @@ /** - * Data returned from the Answers query rules system. + * Data returned from the Search query rules system. * * @public */ diff --git a/src/models/searchservice/response/SearchIntent.ts b/src/models/searchservice/response/SearchIntent.ts index d6a71c05..2b5f951e 100644 --- a/src/models/searchservice/response/SearchIntent.ts +++ b/src/models/searchservice/response/SearchIntent.ts @@ -1,9 +1,9 @@ /** - * Represents intents from the Answers API. + * Represents intents from the Search API. * * @public */ export enum SearchIntent { - /** The Answers API is requesting a prompt for the user's location. */ + /** The Search API is requesting a prompt for the user's location. */ NearMe = 'NEAR_ME' } \ No newline at end of file diff --git a/src/models/searchservice/response/Source.ts b/src/models/searchservice/response/Source.ts index d893a23b..cdd8833f 100644 --- a/src/models/searchservice/response/Source.ts +++ b/src/models/searchservice/response/Source.ts @@ -4,7 +4,7 @@ * @public */ export enum Source { - /** The result is from an Answers Knowledge Graph. */ + /** The result is from a Knowledge Graph. */ KnowledgeManager = 'KNOWLEDGE_MANAGER', /** The result is from Google Custom Search Engine. */ Google = 'GOOGLE_CSE', diff --git a/src/provideCore.ts b/src/provideCore.ts index 4d55b739..be1aac89 100644 --- a/src/provideCore.ts +++ b/src/provideCore.ts @@ -1,28 +1,28 @@ import { SearchServiceImpl } from './infra/SearchServiceImpl'; import { QuestionSubmissionServiceImpl } from './infra/QuestionSubmissionServiceImpl'; import { HttpServiceImpl } from './infra/HttpServiceImpl'; -import { AnswersConfig, AnswersConfigWithDefaulting } from './models/core/AnswersConfig'; +import { SearchConfig, SearchConfigWithDefaulting } from './models/core/SearchConfig'; import { AutocompleteServiceImpl } from './infra/AutocompleteServiceImpl'; import { ApiResponseValidator } from './validation/ApiResponseValidator'; -import { AnswersCore } from './AnswersCore'; +import { SearchCore } from './SearchCore'; import { defaultEndpoints } from './constants'; /** - * The entrypoint to the answers-core library. + * The entrypoint to the search-core library. * * @remarks - * Returns an {@link AnswersCore} instance. + * Returns an {@link SearchCore} instance. * - * @param config - The answers-core config + * @param config - The search-core config * * @public */ -export function provideCore(config: AnswersConfig): AnswersCore { +export function provideCore(config: SearchConfig): SearchCore { if ('apiKey' in config && 'token' in config) { throw new Error('Both apiKey and token are present. Only one authentication method should be provided'); } - const defaultedConfig: AnswersConfigWithDefaulting = { + const defaultedConfig: SearchConfigWithDefaulting = { ...config, endpoints: { ...defaultEndpoints, @@ -38,5 +38,5 @@ export function provideCore(config: AnswersConfig): AnswersCore { defaultedConfig, httpService, apiResponseValidator); const autoCompleteService = new AutocompleteServiceImpl(defaultedConfig, httpService, apiResponseValidator); - return new AnswersCore(searchService, questionSubmissionService, autoCompleteService); + return new SearchCore(searchService, questionSubmissionService, autoCompleteService); } diff --git a/src/services/QuestionSubmissionService.ts b/src/services/QuestionSubmissionService.ts index a5af20e7..a4956654 100644 --- a/src/services/QuestionSubmissionService.ts +++ b/src/services/QuestionSubmissionService.ts @@ -2,7 +2,7 @@ import { QuestionSubmissionResponse } from '../models/questionsubmission/Questio import { QuestionSubmissionRequest } from '../models/questionsubmission/QuestionSubmissionRequest'; /** - * Submits a custom question to the Answers API. + * Submits a custom question to the Search API. * * @public */ diff --git a/src/services/SearchService.ts b/src/services/SearchService.ts index d7e2c645..b08887a1 100644 --- a/src/services/SearchService.ts +++ b/src/services/SearchService.ts @@ -4,7 +4,7 @@ import { VerticalSearchRequest } from '../models/searchservice/request/VerticalS import { VerticalSearchResponse } from '../models/searchservice/response/VerticalSearchResponse'; /** - * A service which performs Yext Answers searches + * A service which performs Yext Search. * * @public */ diff --git a/src/transformers/autocompleteservice/createAutocompleteResponse.ts b/src/transformers/autocompleteservice/createAutocompleteResponse.ts index 7172b5b0..26fadc00 100644 --- a/src/transformers/autocompleteservice/createAutocompleteResponse.ts +++ b/src/transformers/autocompleteservice/createAutocompleteResponse.ts @@ -1,4 +1,4 @@ -import { AnswersError } from '../../models/answersapi/AnswersError'; +import { SearchError } from '../../models/searchapi/SearchError'; import { AutocompleteResponse, FilterSearchResponse } from '../../models/autocompleteservice/AutocompleteResponse'; import { createAutocompleteResult } from './createAutocompleteResult'; @@ -32,7 +32,7 @@ export function createFilterSearchResponse(data: any): FilterSearchResponse { const response = data.response; if (response.failedVerticals && response.failedVerticals.length != 0) { const error = response.failedVerticals[0]; - throw new AnswersError(error.details.description, error.details.responseCode, error.errorType); + throw new SearchError(error.details.description, error.details.responseCode, error.errorType); } const sections = response.sections.map((section: any) => ({ label: section.label, diff --git a/src/transformers/searchservice/createDirectAnswer.ts b/src/transformers/searchservice/createDirectAnswer.ts index 294a1d5d..fdc1cc40 100644 --- a/src/transformers/searchservice/createDirectAnswer.ts +++ b/src/transformers/searchservice/createDirectAnswer.ts @@ -29,6 +29,6 @@ export function createDirectAnswer(data: any): FeaturedSnippetDirectAnswer | Fie snippet: data.answer.snippet }; } else { - throw new Error('The Answers API returned an unknown direct answer type'); + throw new Error('The Search API returned an unknown direct answer type'); } } \ No newline at end of file diff --git a/src/transformers/searchservice/createFailedVertical.ts b/src/transformers/searchservice/createFailedVertical.ts index f34c62b1..b3a55bae 100644 --- a/src/transformers/searchservice/createFailedVertical.ts +++ b/src/transformers/searchservice/createFailedVertical.ts @@ -1,6 +1,5 @@ import { FailedVertical } from '../../models/searchservice/response/FailedVertical'; - export function createFailedVertical(data: any): FailedVertical { return { verticalKey: data.verticalConfigId, diff --git a/src/transformers/searchservice/createUniversalSearchResponse.ts b/src/transformers/searchservice/createUniversalSearchResponse.ts index 4d2f3e45..f02efe4f 100644 --- a/src/transformers/searchservice/createUniversalSearchResponse.ts +++ b/src/transformers/searchservice/createUniversalSearchResponse.ts @@ -19,6 +19,6 @@ export function createUniversalSearchResponse(data: any): UniversalSearchRespons locationBias: data.response.locationBias && createLocationBias(data.response.locationBias), uuid: data.meta.uuid, queryRulesActionsData: data.response.queryRulesActionsData, - failedVerticals: data.response.failedVerticals && data.response.failedVerticals.map(createFailedVertical) + failedVerticals: data.response.failedVerticals?.map(createFailedVertical) }; } \ No newline at end of file diff --git a/src/transformers/searchservice/createVerticalSearchResponse.ts b/src/transformers/searchservice/createVerticalSearchResponse.ts index 4181bd47..74eb0823 100644 --- a/src/transformers/searchservice/createVerticalSearchResponse.ts +++ b/src/transformers/searchservice/createVerticalSearchResponse.ts @@ -16,8 +16,7 @@ export function createVerticalSearchResponse(data: any): VerticalSearchResponse locationBias: data.response.locationBias && createLocationBias(data.response.locationBias), allResultsForVertical: data.response.allResultsForVertical && createVerticalSearchResponse({ response: data.response.allResultsForVertical }), - alternativeVerticals: data.response.alternativeVerticals && data.response.alternativeVerticals.modules - && data.response.alternativeVerticals.modules.map(createVerticalResults), + alternativeVerticals: data.response.alternativeVerticals?.modules?.map(createVerticalResults), uuid: data.meta?.uuid, queryRulesActionsData: data.response.queryRulesActionsData }; diff --git a/src/utils/urlutils.ts b/src/utils/urlutils.ts index b5c6fa75..71b89c35 100644 --- a/src/utils/urlutils.ts +++ b/src/utils/urlutils.ts @@ -10,7 +10,7 @@ export function addParamsToURL( const parsedUrl = new URL(url); const urlParams = new URLSearchParams(parsedUrl.search.substring(1)); - const sanitizedParams: SanitizedQueryParams = sanitizeQueryParams (params); + const sanitizedParams: SanitizedQueryParams = sanitizeQueryParams(params); for (const key in sanitizedParams) { urlParams.append(key, sanitizedParams[key].toString()); diff --git a/src/validation/ApiResponseValidator.ts b/src/validation/ApiResponseValidator.ts index 971f264d..620609fa 100644 --- a/src/validation/ApiResponseValidator.ts +++ b/src/validation/ApiResponseValidator.ts @@ -1,13 +1,13 @@ -import { ApiResponse } from '../models/answersapi/ApiResponse'; -import { AnswersError } from '../models/answersapi/AnswersError'; +import { ApiResponse } from '../models/searchapi/ApiResponse'; +import { SearchError } from '../models/searchapi/SearchError'; /** - * Determines whether or not an API response can be used to construct an answers-core response + * Determines whether or not an API response can be used to construct a search-core response. * * @internal */ export class ApiResponseValidator { - public validate(apiResponse: ApiResponse): AnswersError | undefined { + public validate(apiResponse: ApiResponse): SearchError | undefined { const testFunctions = [ this.validateResponseProp, this.validateMetaProp, @@ -19,22 +19,22 @@ export class ApiResponseValidator { return testResults.find(result => result); } - private validateResponseProp(apiResponse: ApiResponse): AnswersError | undefined { + private validateResponseProp(apiResponse: ApiResponse): SearchError | undefined { if (!apiResponse.response) { - return new AnswersError('Malformed Answers API response: missing response property.'); + return new SearchError('Malformed Search API response: missing response property.'); } } - private validateMetaProp(apiResponse: ApiResponse): AnswersError | undefined { + private validateMetaProp(apiResponse: ApiResponse): SearchError | undefined { if (!apiResponse.meta) { - return new AnswersError('Malformed Answers API response: missing meta property.'); + return new SearchError('Malformed Search API response: missing meta property.'); } } - private checkForApiErrors(apiResponse: ApiResponse): AnswersError | undefined { + private checkForApiErrors(apiResponse: ApiResponse): SearchError | undefined { if (apiResponse.meta?.errors?.length >= 1) { const error = apiResponse.meta.errors[0]; - return new AnswersError(error.message, error.code, error.type); + return new SearchError(error.message, error.code, error.type); } } } \ No newline at end of file diff --git a/test-site/index.html b/test-site/index.html index 4ab2f544..0c435a86 100644 --- a/test-site/index.html +++ b/test-site/index.html @@ -2,7 +2,7 @@ - Answers Core Testing + Search Core Testing diff --git a/test-site/js-index.html b/test-site/js-index.html index 4cc26989..c48885f0 100644 --- a/test-site/js-index.html +++ b/test-site/js-index.html @@ -2,7 +2,7 @@ - Answers Core Testing + Search Core Testing diff --git a/test-site/package-lock.json b/test-site/package-lock.json index f47bcd72..640272df 100644 --- a/test-site/package-lock.json +++ b/test-site/package-lock.json @@ -1,11 +1,11 @@ { - "name": "answers-core-test-repo", + "name": "search-core-test-repo", "version": "1.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "answers-core-test-repo", + "name": "search-core-test-repo", "version": "1.0.0", "hasInstallScript": true, "license": "ISC", diff --git a/test-site/package.json b/test-site/package.json index b174a005..9a080e97 100644 --- a/test-site/package.json +++ b/test-site/package.json @@ -1,7 +1,7 @@ { - "name": "answers-core-test-repo", + "name": "search-core-test-repo", "version": "1.0.0", - "description": "testing of the answers-core", + "description": "testing of the search-core", "private": "true", "devDependencies": { "ts-loader": "^9.2.6", diff --git a/test-site/src/js/index.js b/test-site/src/js/index.js index 77ab0559..8ce2e33b 100644 --- a/test-site/src/js/index.js +++ b/test-site/src/js/index.js @@ -1,5 +1,5 @@ /* eslint-disable @typescript-eslint/explicit-module-boundary-types */ -import { provideCore } from '@yext/answers-core'; +import { provideCore } from '@yext/search-core'; import verticalRequest from './requests/verticalRequest'; import universalRequest from './requests/universalRequest'; import questionRequest from './requests/questionRequest'; diff --git a/test-site/src/js/requests/universalRequest.js b/test-site/src/js/requests/universalRequest.js index c81e6d49..358a498a 100644 --- a/test-site/src/js/requests/universalRequest.js +++ b/test-site/src/js/requests/universalRequest.js @@ -1,4 +1,4 @@ -import { QueryTrigger } from '@yext/answers-core'; +import { QueryTrigger } from '@yext/search-core'; const universalRequest = { query: 'office near me', diff --git a/test-site/src/js/requests/verticalRequest.js b/test-site/src/js/requests/verticalRequest.js index 1991a91e..9c594d51 100644 --- a/test-site/src/js/requests/verticalRequest.js +++ b/test-site/src/js/requests/verticalRequest.js @@ -1,4 +1,4 @@ -import { QueryTrigger } from '@yext/answers-core'; +import { QueryTrigger } from '@yext/search-core'; const verticalRequest = { verticalKey: 'people', diff --git a/test-site/src/ts/index.ts b/test-site/src/ts/index.ts index e791b147..675ac3cb 100644 --- a/test-site/src/ts/index.ts +++ b/test-site/src/ts/index.ts @@ -1,10 +1,10 @@ -import { provideCore, AnswersConfig, AnswersCore } from '@yext/answers-core'; +import { provideCore, SearchConfig, SearchCore } from '@yext/search-core'; import verticalRequest from './requests/verticalRequest'; import universalRequest from './requests/universalRequest'; import questionRequest from './requests/questionRequest'; import { univeralAutocompleteRequest, verticalAutocompleteRequest, filterSearchRequest } from './requests/autocompleteRequests'; -const coreConfig: AnswersConfig = { +const coreConfig: SearchConfig = { apiKey: '2d8c550071a64ea23e263118a2b0680b', experienceKey: 'slanswers', locale: 'en', @@ -16,7 +16,7 @@ window.onload = () => { document.body.appendChild(element); }; -const globalCore: AnswersCore = provideCore(coreConfig); +const globalCore: SearchCore = provideCore(coreConfig); export async function universalSearch(): Promise { loadingSpinner(); diff --git a/test-site/src/ts/requests/autocompleteRequests.ts b/test-site/src/ts/requests/autocompleteRequests.ts index 3e9cd7b2..782cc070 100644 --- a/test-site/src/ts/requests/autocompleteRequests.ts +++ b/test-site/src/ts/requests/autocompleteRequests.ts @@ -1,5 +1,9 @@ -import { UniversalAutocompleteRequest, VerticalAutocompleteRequest, FilterSearchRequest, Matcher } - from '@yext/answers-core'; +import { + UniversalAutocompleteRequest, + VerticalAutocompleteRequest, + FilterSearchRequest, + Matcher +} from '@yext/search-core'; export const univeralAutocompleteRequest: UniversalAutocompleteRequest = { input: 'virginiaa', diff --git a/test-site/src/ts/requests/questionRequest.ts b/test-site/src/ts/requests/questionRequest.ts index 32515006..066984f6 100644 --- a/test-site/src/ts/requests/questionRequest.ts +++ b/test-site/src/ts/requests/questionRequest.ts @@ -1,4 +1,4 @@ -import { QuestionSubmissionRequest } from '@yext/answers-core'; +import { QuestionSubmissionRequest } from '@yext/search-core'; const questionRequest: QuestionSubmissionRequest = { email: 'oshi@yext.com', diff --git a/test-site/src/ts/requests/universalRequest.ts b/test-site/src/ts/requests/universalRequest.ts index 585f5354..cd78ee9c 100644 --- a/test-site/src/ts/requests/universalRequest.ts +++ b/test-site/src/ts/requests/universalRequest.ts @@ -1,4 +1,4 @@ -import { QueryTrigger, UniversalSearchRequest } from '@yext/answers-core'; +import { QueryTrigger, UniversalSearchRequest } from '@yext/search-core'; const universalRequest: UniversalSearchRequest = { query: 'office near me', diff --git a/test-site/src/ts/requests/verticalRequest.ts b/test-site/src/ts/requests/verticalRequest.ts index 9776bfba..1079b41d 100644 --- a/test-site/src/ts/requests/verticalRequest.ts +++ b/test-site/src/ts/requests/verticalRequest.ts @@ -1,5 +1,4 @@ -import { QueryTrigger } from '@yext/answers-core'; -import { VerticalSearchRequest } from '@yext/answers-core'; +import { QueryTrigger, VerticalSearchRequest } from '@yext/search-core'; const verticalRequest: VerticalSearchRequest = { verticalKey: 'people', diff --git a/tests/infra/AutocompleteServiceImpl.ts b/tests/infra/AutocompleteServiceImpl.ts index 52bbeb6f..5d2838ee 100644 --- a/tests/infra/AutocompleteServiceImpl.ts +++ b/tests/infra/AutocompleteServiceImpl.ts @@ -1,5 +1,5 @@ import { HttpServiceMock } from '../mocks/HttpServiceMock'; -import { AnswersConfigWithDefaulting } from '../../src/models/core/AnswersConfig'; +import { SearchConfigWithDefaulting } from '../../src/models/core/SearchConfig'; import { UniversalAutocompleteRequest, VerticalAutocompleteRequest, @@ -13,13 +13,13 @@ import mockAutocompleteResponseWithFailedVerticals from '../fixtures/autocomplet import mockAutocompleteResponseWithVerticalKeys from '../fixtures/autocompleteresponsewithverticalkeys.json'; import { defaultEndpoints, defaultApiVersion } from '../../src/constants'; import { ApiResponseValidator } from '../../src/validation/ApiResponseValidator'; -import { ApiResponse } from '../../src/models/answersapi/ApiResponse'; -import { AnswersError } from '../../src/models/answersapi/AnswersError'; +import { ApiResponse } from '../../src/models/searchapi/ApiResponse'; +import { SearchError } from '../../src/models/searchapi/SearchError'; import { getClientSdk } from '../../src/utils/getClientSdk'; import { Matcher } from '../../src/models/searchservice/common/Matcher'; describe('AutocompleteService', () => { - const config: AnswersConfigWithDefaulting = { + const config: SearchConfigWithDefaulting = { apiKey: 'testApiKey', experienceKey: 'testExperienceKey', locale: 'en', @@ -30,7 +30,7 @@ describe('AutocompleteService', () => { endpoints: defaultEndpoints }; - const configWithToken: AnswersConfigWithDefaulting = { + const configWithToken: SearchConfigWithDefaulting = { token: 'testToken', experienceKey: 'testExperienceKey', locale: 'en', @@ -41,15 +41,15 @@ describe('AutocompleteService', () => { const apiResponseValidator = new ApiResponseValidator(); function createMockAutocompleteService(params?: { response?: ApiResponse, - answersConfig?: AnswersConfigWithDefaulting + searchConfig?: SearchConfigWithDefaulting }) { const { response = mockAutocompleteResponse, - answersConfig = config + searchConfig = config } = params || {}; mockHttpService.get.mockResolvedValue(response); return new AutocompleteServiceImpl( - answersConfig, + searchConfig, mockHttpService as HttpService, apiResponseValidator ); @@ -85,7 +85,7 @@ describe('AutocompleteService', () => { }); it('query params are correct with token', async () => { - const autocompleteService = createMockAutocompleteService({ answersConfig: configWithToken }); + const autocompleteService = createMockAutocompleteService({ searchConfig: configWithToken }); const expectedQueryParams = { input: '', experienceKey: 'testExperienceKey', @@ -171,7 +171,7 @@ describe('AutocompleteService', () => { }); it('query params are correct with token', async () => { - const autocompleteService = createMockAutocompleteService({ answersConfig: configWithToken }); + const autocompleteService = createMockAutocompleteService({ searchConfig: configWithToken }); const { api_key: _, ...expectedParams } = expectedQueryParams; await autocompleteService.verticalAutocomplete(request); @@ -259,13 +259,13 @@ describe('AutocompleteService', () => { message: 'Something went wrong.', code: 400, type: 'BACKEND_ERROR' - } as AnswersError); + } as SearchError); }); }); }); describe('additionalQueryParams are passed through', () => { - const config: AnswersConfigWithDefaulting = { + const config: SearchConfigWithDefaulting = { apiKey: 'testApiKey', experienceKey: 'testExperienceKey', locale: 'en', diff --git a/tests/infra/HttpServiceImpl.js b/tests/infra/HttpServiceImpl.js index f71d7da6..d589302e 100644 --- a/tests/infra/HttpServiceImpl.js +++ b/tests/infra/HttpServiceImpl.js @@ -108,7 +108,6 @@ describe('HttpServiceImpl', () => { expect(fetch).toHaveBeenLastCalledWith('http://yext.com/?nodeQuery=param', expect.anything()); }); - it('makes request with custom client SDK, but only when not falsy', async () => { const queryParams = { aQuery: 'param' diff --git a/tests/infra/QuestionSubmissionServiceImpl.ts b/tests/infra/QuestionSubmissionServiceImpl.ts index b8686ea3..87933a2a 100644 --- a/tests/infra/QuestionSubmissionServiceImpl.ts +++ b/tests/infra/QuestionSubmissionServiceImpl.ts @@ -1,7 +1,7 @@ import { QuestionSubmissionServiceImpl } from '../../src/infra/QuestionSubmissionServiceImpl'; import { HttpServiceMock } from '../mocks/HttpServiceMock'; import { HttpService } from '../../src/services/HttpService'; -import { AnswersConfigWithDefaulting } from '../../src/models/core/AnswersConfig'; +import { SearchConfigWithDefaulting } from '../../src/models/core/SearchConfig'; import { ApiResponseValidator } from '../../src/validation/ApiResponseValidator'; import { defaultApiVersion, defaultEndpoints } from '../../src/constants'; @@ -49,7 +49,7 @@ describe('Question submission', () => { it('a custom endpoint may be supplied', async () => { const expectedUrl = 'https://custom.endpoint.com/api'; - const coreConfig: AnswersConfigWithDefaulting = { + const coreConfig: SearchConfigWithDefaulting = { ...baseCoreConfig, endpoints: { questionSubmission: 'https://custom.endpoint.com/api' diff --git a/tests/infra/SearchServiceImpl.ts b/tests/infra/SearchServiceImpl.ts index 95163f44..3395c364 100644 --- a/tests/infra/SearchServiceImpl.ts +++ b/tests/infra/SearchServiceImpl.ts @@ -1,6 +1,6 @@ import { HttpServiceMock } from '../mocks/HttpServiceMock'; import { SearchServiceImpl } from '../../src/infra/SearchServiceImpl'; -import { AnswersConfigWithDefaulting } from '../../src/models/core/AnswersConfig'; +import { SearchConfigWithDefaulting } from '../../src/models/core/SearchConfig'; import { UniversalSearchRequest } from '../../src/models/searchservice/request/UniversalSearchRequest'; import { HttpService } from '../../src/services/HttpService'; import { QueryTrigger } from '../../src/models/searchservice/request/QueryTrigger'; @@ -14,21 +14,21 @@ import { getClientSdk } from '../../src/utils/getClientSdk'; import { defaultApiVersion, defaultEndpoints } from '../../src/constants'; describe('SearchService', () => { - const configWithRequiredApiKey: AnswersConfigWithDefaulting = { + const configWithRequiredApiKey: SearchConfigWithDefaulting = { apiKey: 'testApiKey', experienceKey: 'testExperienceKey', locale: 'en', endpoints: defaultEndpoints }; - const configWithRequiredToken: AnswersConfigWithDefaulting = { + const configWithRequiredToken: SearchConfigWithDefaulting = { token: 'testToken', experienceKey: 'testExperienceKey', locale: 'en', endpoints: defaultEndpoints }; - const configWithAllParams: AnswersConfigWithDefaulting = { + const configWithAllParams: SearchConfigWithDefaulting = { apiKey: 'testApiKey', experienceKey: 'testExperienceKey', locale: 'es', @@ -130,7 +130,7 @@ describe('SearchService', () => { }; const expectedQueryParams = { api_key: 'testApiKey', - context: JSON.stringify({ key:'value' }), + context: JSON.stringify({ key: 'value' }), experienceKey: 'testExperienceKey', limit: JSON.stringify({ people: 17 }), input: 'testQuery', @@ -155,7 +155,7 @@ describe('SearchService', () => { it('A custom universal search service endpoint may be supplied', async () => { const customUrl = 'http://custom.endpoint.com/api'; - const config: AnswersConfigWithDefaulting = { + const config: SearchConfigWithDefaulting = { ...configWithRequiredApiKey, endpoints: { ...defaultEndpoints, @@ -286,12 +286,12 @@ describe('SearchService', () => { context: JSON.stringify({ key: 'value' }), experienceKey: 'testExperienceKey', facetFilters: JSON.stringify({ - c_awards:[{ - c_awards: { $eq:'Impact Award' } + c_awards: [{ + c_awards: { $eq: 'Impact Award' } }] }), filters: JSON.stringify({ - city:{ ['!$eq']: 'Arlington' } + city: { ['!$eq']: 'Arlington' } }), input: 'testQuery', limit: 10, @@ -307,8 +307,8 @@ describe('SearchService', () => { sessionTrackingEnabled: true, skipSpellCheck: true, sortBys: JSON.stringify([{ - direction:'ASC', - field:'name', + direction: 'ASC', + field: 'name', type: 'FIELD' }]), source: 'STANDARD', @@ -388,7 +388,7 @@ describe('SearchService', () => { }); describe('additionalQueryParams are passed through', () => { - const coreConfig: AnswersConfigWithDefaulting = { + const coreConfig: SearchConfigWithDefaulting = { apiKey: 'testApiKey', experienceKey: 'testExperienceKey', locale: 'en', diff --git a/tests/provideCore.ts b/tests/provideCore.ts index b4fba42b..92615fdb 100644 --- a/tests/provideCore.ts +++ b/tests/provideCore.ts @@ -5,7 +5,7 @@ import { SearchServiceImpl } from '../src/infra/SearchServiceImpl'; import { Endpoints } from '../src/models/core/Endpoints'; import { provideCore } from '../src/provideCore'; -jest.mock('../src/AnswersCore'); +jest.mock('../src/SearchCore'); jest.mock('../src/infra/AutocompleteServiceImpl'); jest.mock('../src/infra/QuestionSubmissionServiceImpl'); jest.mock('../src/infra/SearchServiceImpl'); diff --git a/tests/serializers/serializeFacets.ts b/tests/serializers/serializeFacets.ts index ad73170a..bb1d231b 100644 --- a/tests/serializers/serializeFacets.ts +++ b/tests/serializers/serializeFacets.ts @@ -6,10 +6,12 @@ it('serializeFacets serializes facets properly', () => { { fieldId: 'c_jobCategory', options: [ { matcher: Matcher.Equals, value: 'Sales' }, { matcher: Matcher.Equals, value: 'Client Success' }, - { matcher: Matcher.Equals, value: 'Finance' }] }, + { matcher: Matcher.Equals, value: 'Finance' } + ] }, { fieldId: 'c_jobLocationShortDescription', options: [ { matcher: Matcher.Equals, value: 'New York' }, - { matcher: Matcher.Equals, value: 'Chicago' }] }, + { matcher: Matcher.Equals, value: 'Chicago' } + ] }, ]); const expectedSerializedFilters = { @@ -43,7 +45,8 @@ it('serializeFacets serializes a mix of disabled and enabled filters properly', const actualSerializedFilters = serializeFacets([ { fieldId: 'c_jobCategory', options: [ { matcher: Matcher.Equals, value: 'Sales' }, - { matcher: Matcher.Equals, value: 'Client Success' }] }, + { matcher: Matcher.Equals, value: 'Client Success' } + ] }, { fieldId: 'c_jobLocationShortDescription', options: [] }, ]); @@ -57,7 +60,6 @@ it('serializeFacets serializes a mix of disabled and enabled filters properly', expect(actualSerializedFilters).toEqual(JSON.stringify(expectedSerializedFilters)); }); - it('serializeFacets serializes number range facets properly', () => { const actualSerializedFilters = serializeFacets([ { diff --git a/tests/transformers/autocompleteservice/createAutocompleteResult.ts b/tests/transformers/autocompleteservice/createAutocompleteResult.ts index 7f4fb2d9..30fa9be5 100644 --- a/tests/transformers/autocompleteservice/createAutocompleteResult.ts +++ b/tests/transformers/autocompleteservice/createAutocompleteResult.ts @@ -1,6 +1,5 @@ import { createAutocompleteResult } from '../../../src/transformers/autocompleteservice/createAutocompleteResult'; - describe('AutocompleteResult', () => { it('result with no filter is parsed correctly', () => { const resultWithNoFilter = { diff --git a/tests/transformers/createAppliedQueryFilter.ts b/tests/transformers/createAppliedQueryFilter.ts index f044353b..e2e26f50 100644 --- a/tests/transformers/createAppliedQueryFilter.ts +++ b/tests/transformers/createAppliedQueryFilter.ts @@ -48,7 +48,7 @@ it('createAppliedQueryFilter correctly transforms appliedQueryFilters with "INTE } } }, - type:'INTENT' + type: 'INTENT' } ] }; @@ -91,7 +91,7 @@ it('createAppliedQueryFilter correctly transforms appliedQueryFilters with "PLAC { displayKey: 'Location', displayValue: 'Virginia', - filter:{ + filter: { 'builtin.location': { '$eq': 'P-region.7919684583758790' } diff --git a/tests/transformers/searchservice/ResultsFactory.ts b/tests/transformers/searchservice/ResultsFactory.ts index ab5bb87a..210c1c50 100644 --- a/tests/transformers/searchservice/ResultsFactory.ts +++ b/tests/transformers/searchservice/ResultsFactory.ts @@ -15,8 +15,7 @@ it('properly transforms Knowledge Graph results', () => { highlightedFields: {}, distance: 36032, distanceFromFilter: 3821 - } - ]; + }]; const expectedResults = [{ description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit', distance: 36032, diff --git a/tests/validation/ApiResponseValidator.ts b/tests/validation/ApiResponseValidator.ts index ef1fcc10..a4e14031 100644 --- a/tests/validation/ApiResponseValidator.ts +++ b/tests/validation/ApiResponseValidator.ts @@ -1,6 +1,6 @@ import { ApiResponseValidator } from '../../src/validation/ApiResponseValidator'; -import { ApiResponse } from '../../src/models/answersapi/ApiResponse'; -import { AnswersError } from '../../src/models/answersapi/AnswersError'; +import { ApiResponse } from '../../src/models/searchapi/ApiResponse'; +import { SearchError } from '../../src/models/searchapi/SearchError'; const apiResponseValidator = new ApiResponseValidator(); @@ -26,7 +26,7 @@ it('A response without a response property fails validation', () => { } as ApiResponse; const validationResponse = apiResponseValidator.validate(response); - return expect(validationResponse).toBeInstanceOf(AnswersError); + return expect(validationResponse).toBeInstanceOf(SearchError); }); it('A response without a meta property fails validation', () => { @@ -35,7 +35,7 @@ it('A response without a meta property fails validation', () => { } as ApiResponse; const validationResponse = apiResponseValidator.validate(response); - return expect(validationResponse).toBeInstanceOf(AnswersError); + return expect(validationResponse).toBeInstanceOf(SearchError); }); it('A response with an error fails validation', () => { @@ -54,5 +54,5 @@ it('A response with an error fails validation', () => { }; const validationResponse = apiResponseValidator.validate(response); - return expect(validationResponse).toBeInstanceOf(AnswersError); + return expect(validationResponse).toBeInstanceOf(SearchError); }); \ No newline at end of file