v1.2.0

## Version 1.2.0
### Changes
- The `fieldType` attribute has been added to the `DirectAnswer` model. (#84)
- The `endpoints` attribute of `AnswersConfig` is now public, as is the `Endpoints` type. This attribute can be used to override the endpoints for search, autocomplete, and question submission. (#81)
- Added test coverage reports to the repository. (#78)

### Bug Fixes
- The `Snippet` type is now properly exported. (#83)

.eslintrc.js

@@ -8,17 +8,18 @@ module.exports = {
     'plugin:@typescript-eslint/recommended'
   ],
   rules: {
+    indent: ['error', 2],
     'no-trailing-spaces' : ['error'],
     'no-multi-spaces' : ['error'],
     quotes: ['error', 'single'],
     'space-before-function-paren': ['error', {
-        named: 'never',
-        anonymous: 'never'
+      named: 'never',
+      anonymous: 'never'
     }],
     'quote-props': ['error', 'as-needed'],
     'max-len': ['error', {
-        code: 125,
-        ignorePattern: '^import\\s.+\\sfrom\\s.+;$'
+      code: 125,
+      ignorePattern: '^import\\s.+\\sfrom\\s.+;$'
     }],
     '@typescript-eslint/semi': ['error'],
     '@typescript-eslint/type-annotation-spacing': ['error'],

.github/workflows/coverage.yml

@@ -0,0 +1,30 @@
+# This workflow will run our tests, generate an lcov code coverage file,
+# and send that coverage to Coveralls 
+
+name: Code Coverage
+
+on:
+  push:
+    branches-ignore: dev/*
+  pull_request:
+
+jobs:
+  Coveralls:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npx jest --coverage
+    - name: Coveralls
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -8,6 +8,9 @@
   <a href="./LICENSE">
     <img src="https://img.shields.io/badge/License-BSD%203--Clause-blue.svg" alt="License"/>
   </a>
+  <a href='https://coveralls.io/github/yext/answers-core?branch=master'>
+    <img src='https://coveralls.io/repos/github/yext/answers-core/badge.svg?branch=master' alt='Coverage Status' />
+  </a>
 </div>
 <br>
 

docs/answers-core.answersconfig.endpoints.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [AnswersConfig](./answers-core.answersconfig.md) &gt; [endpoints](./answers-core.answersconfig.endpoints.md)
+
+## AnswersConfig.endpoints property
+
+Overrides for the URLs which are used when making requests to the Answers API.
+
+<b>Signature:</b>
+
+```typescript
+endpoints?: Endpoints;
+```

docs/answers-core.answersconfig.md

@@ -17,6 +17,7 @@ export interface AnswersConfig
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [apiKey](./answers-core.answersconfig.apikey.md) | string | The api key of the answers experience. |
+|  [endpoints?](./answers-core.answersconfig.endpoints.md) | [Endpoints](./answers-core.endpoints.md) | <i>(Optional)</i> Overrides for the URLs which are used when making requests to the Answers API. |
 |  [experienceKey](./answers-core.answersconfig.experiencekey.md) | string | The experience key of the answers experience. |
 |  [experienceVersion?](./answers-core.answersconfig.experienceversion.md) | 'STAGING' \| 'PRODUCTION' \| string \| number | <i>(Optional)</i> The version of the answers experience configuration. |
 |  [locale](./answers-core.answersconfig.locale.md) | string | The locale of the answers experience. |

docs/answers-core.directanswer.fieldtype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [DirectAnswer](./answers-core.directanswer.md) &gt; [fieldType](./answers-core.directanswer.fieldtype.md)
+
+## DirectAnswer.fieldType property
+
+The field type of the direct answer.
+
+<b>Signature:</b>
+
+```typescript
+fieldType: string;
+```

docs/answers-core.directanswer.md

@@ -16,8 +16,9 @@ export interface DirectAnswer
 
 |  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 | The result of the direct answer. |
+|  [value?](./answers-core.directanswer.value.md) | string | <i>(Optional)</i> The result of the direct answer. |
 |  [verticalKey](./answers-core.directanswer.verticalkey.md) | string | The vertical key of the direct answer. |
 

docs/answers-core.directanswer.value.md

@@ -9,5 +9,10 @@ The result of the direct answer.
 <b>Signature:</b>
 
 ```typescript
-value: string;
+value?: string;
 ```
+
+## Remarks
+
+A value will not be present if the [DirectAnswer.fieldType](./answers-core.directanswer.fieldtype.md) is 'rich\_text'.
+

docs/answers-core.endpoints.filtersearch.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [Endpoints](./answers-core.endpoints.md) &gt; [filterSearch](./answers-core.endpoints.filtersearch.md)
+
+## Endpoints.filterSearch property
+
+<b>Signature:</b>
+
+```typescript
+filterSearch?: string;
+```

docs/answers-core.endpoints.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [Endpoints](./answers-core.endpoints.md)
+
+## Endpoints interface
+
+Overrides for the URLs which are used when making requests to the Answers API.
+
+<b>Signature:</b>
+
+```typescript
+export interface Endpoints 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [filterSearch?](./answers-core.endpoints.filtersearch.md) | string | <i>(Optional)</i> |
+|  [questionSubmission?](./answers-core.endpoints.questionsubmission.md) | string | <i>(Optional)</i> |
+|  [status?](./answers-core.endpoints.status.md) | string | <i>(Optional)</i> |
+|  [universalAutocomplete?](./answers-core.endpoints.universalautocomplete.md) | string | <i>(Optional)</i> |
+|  [universalSearch?](./answers-core.endpoints.universalsearch.md) | string | <i>(Optional)</i> |
+|  [verticalAutocomplete?](./answers-core.endpoints.verticalautocomplete.md) | string | <i>(Optional)</i> |
+|  [verticalSearch?](./answers-core.endpoints.verticalsearch.md) | string | <i>(Optional)</i> |
+

docs/answers-core.endpoints.questionsubmission.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [Endpoints](./answers-core.endpoints.md) &gt; [questionSubmission](./answers-core.endpoints.questionsubmission.md)
+
+## Endpoints.questionSubmission property
+
+<b>Signature:</b>
+
+```typescript
+questionSubmission?: string;
+```

docs/answers-core.endpoints.status.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [Endpoints](./answers-core.endpoints.md) &gt; [status](./answers-core.endpoints.status.md)
+
+## Endpoints.status property
+
+<b>Signature:</b>
+
+```typescript
+status?: string;
+```

docs/answers-core.endpoints.universalautocomplete.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [Endpoints](./answers-core.endpoints.md) &gt; [universalAutocomplete](./answers-core.endpoints.universalautocomplete.md)
+
+## Endpoints.universalAutocomplete property
+
+<b>Signature:</b>
+
+```typescript
+universalAutocomplete?: string;
+```

docs/answers-core.endpoints.universalsearch.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [Endpoints](./answers-core.endpoints.md) &gt; [universalSearch](./answers-core.endpoints.universalsearch.md)
+
+## Endpoints.universalSearch property
+
+<b>Signature:</b>
+
+```typescript
+universalSearch?: string;
+```

docs/answers-core.endpoints.verticalautocomplete.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [Endpoints](./answers-core.endpoints.md) &gt; [verticalAutocomplete](./answers-core.endpoints.verticalautocomplete.md)
+
+## Endpoints.verticalAutocomplete property
+
+<b>Signature:</b>
+
+```typescript
+verticalAutocomplete?: string;
+```

docs/answers-core.endpoints.verticalsearch.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [Endpoints](./answers-core.endpoints.md) &gt; [verticalSearch](./answers-core.endpoints.verticalsearch.md)
+
+## Endpoints.verticalSearch property
+
+<b>Signature:</b>
+
+```typescript
+verticalSearch?: string;
+```

docs/answers-core.featuredsnippetdirectanswer.fieldtype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) &gt; [fieldType](./answers-core.featuredsnippetdirectanswer.fieldtype.md)
+
+## FeaturedSnippetDirectAnswer.fieldType property
+
+The field type of the direct answer.
+
+<b>Signature:</b>
+
+```typescript
+fieldType: string;
+```

docs/answers-core.featuredsnippetdirectanswer.md

@@ -17,9 +17,10 @@ export interface FeaturedSnippetDirectAnswer extends DirectAnswer
 
 |  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 | The snippet where the direct answer was found. |
+|  [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.featuredsnippet.md) | [DirectAnswerType](./answers-core.directanswertype.md)<!-- -->.FeaturedSnippet. |
-|  [value](./answers-core.featuredsnippetdirectanswer.value.md) | string | The result of the direct answer. |
+|  [value?](./answers-core.featuredsnippetdirectanswer.value.md) | string | <i>(Optional)</i> The result of the direct answer. |
 |  [verticalKey](./answers-core.featuredsnippetdirectanswer.verticalkey.md) | string | The vertical key of the direct answer. |
 

docs/answers-core.featuredsnippetdirectanswer.value.md

@@ -9,5 +9,10 @@ The result of the direct answer.
 <b>Signature:</b>
 
 ```typescript
-value: string;
+value?: string;
 ```
+
+## Remarks
+
+A value will not be present if the [DirectAnswer.fieldType](./answers-core.directanswer.fieldtype.md) is 'rich\_text'.
+

docs/answers-core.fieldvaluedirectanswer.value.md

@@ -11,3 +11,8 @@ The result of the direct answer.
 ```typescript
 value: string;
 ```
+
+## Remarks
+
+A value will not be present if the [DirectAnswer.fieldType](./answers-core.directanswer.fieldtype.md) is 'rich\_text'.
+

docs/answers-core.md

@@ -45,6 +45,7 @@
 |  [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. |
 |  [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) | A direct answer which was found within a document. |
@@ -60,6 +61,7 @@
 |  [QuestionSubmissionResponse](./answers-core.questionsubmissionresponse.md) | A representation of a question submission response. |
 |  [Result](./answers-core.result.md) | An individual search result. |
 |  [SearchParameterField](./answers-core.searchparameterfield.md) | Indicates which entity field to perform the autocomplete request on. |
+|  [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. |

docs/answers-core.snippet.matchedsubstrings.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [Snippet](./answers-core.snippet.md) &gt; [matchedSubstrings](./answers-core.snippet.matchedsubstrings.md)
+
+## Snippet.matchedSubstrings property
+
+The locations in the document text of the [FeaturedSnippetDirectAnswer.value](./answers-core.featuredsnippetdirectanswer.value.md)
+
+<b>Signature:</b>
+
+```typescript
+matchedSubstrings: {
+        offset: number;
+        length: number;
+    }[];
+```

docs/answers-core.snippet.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [Snippet](./answers-core.snippet.md)
+
+## Snippet interface
+
+The section of text where a [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) was found.
+
+<b>Signature:</b>
+
+```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 |
+

docs/answers-core.snippet.value.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [Snippet](./answers-core.snippet.md) &gt; [value](./answers-core.snippet.value.md)
+
+## Snippet.value property
+
+The snippet's body of text
+
+<b>Signature:</b>
+
+```typescript
+value: string;
+```