add featured snippet DA interfaces for the builtin fieldType #207
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull Request Test Coverage Report for Build 2862788583
💛 - Coveralls |
oshi97
reviewed
Aug 15, 2022
| * | ||
| * @public | ||
| */ | ||
| export interface RichTextFeaturedSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> { |
There was a problem hiding this comment.
are you sure you don't want to put RichTextFeaturedSnippetDirectAnswer, MultiLineTextFeaturedSnippetDirectAnswer, and BaseFeaturedSnippetDirectAnswer into FeaturedSnippetDirectAnswer.ts ? There's a lot of jumping around when I try to navigate the code, and each file is less than 20 lines (with ~4 of those lines being import statements) and I don't see them getting much bigger in the future
There was a problem hiding this comment.
It would only add about ~30 lines to FeaturedSnippetDirectAnswer.ts, I feel like that's totally reasonable
There was a problem hiding this comment.
I guess for me it just feels like there's a lot of small files and it's hard to quickly form a mental model around what we're working with? Mostly because of the large number of adjectives we've had to prefix DirectAnswer with
There was a problem hiding this comment.
sure, I can combine them
oshi97
reviewed
Aug 15, 2022
src/models/searchservice/response/directanswer/FeaturedSnippetDirectAnswer.ts
Outdated
Show resolved
Hide resolved
nmanu1
reviewed
Aug 15, 2022
src/models/searchservice/response/directanswer/MultiLineTextFeaturedSnippetDirectAnswer.ts
Outdated
Show resolved
Hide resolved
src/models/searchservice/response/directanswer/MultiLineTextFeaturedSnippetDirectAnswer.ts
Outdated
Show resolved
Hide resolved
nmanu1
reviewed
Aug 15, 2022
src/models/searchservice/response/directanswer/BaseFeaturedSnippetDirectAnswer.ts
Outdated
Show resolved
Hide resolved
Merged
yen-tt
added a commit
that referenced
this pull request
Sep 8, 2022
## Version 2.0.0 ### Changes - `additionalQueryParameter` is now a public field in `SearchConfig` models (#217) ### Breaking Changes - Updated default and sandbox URL endpoints from `../answers/..` to `../search/..` as part of rebranding process (#196 ) - Restructured StaticFilters models for better developer experience and enforce proper restriction in the kind of combinations of filters supported by the backend - Now, static filters can be either a field value filter or a nested object that is composed by combining field value filters. (#201 ) - `ConjunctionStaticFilter` and `DisjunctionStaticFilter` models were created to reflect such limitation. For example, ANDs of ORs combination is allowed, ORs of ANDs combination is not allowed. (#204 ) - Updated `FieldValueDirectAnswer` model to properly handle different `value` types. Previously, FieldValueDirectAnswer interface enforces that the `value` field will always be of type `string`. Now, `FieldValueDirectAnswer` is a union type of predefined interfaces with known `value` type and `UnknownFieldValueDirectAnswer` with a generic `value` type for other `fieldType` outside of `BuiltInFieldType`. (#200 #202 ) - The newly added built-in interfaces can be found in the document page [**here**](https://github.com/yext/search-core/blob/develop/docs/search-core.fieldvaluedirectanswer.md) (#206 #208 #210 #211 #205 #209 #203 #220 ) - Narrow down `FeaturedSnippetDirectAnswer` TypeScript model to be a union type of `MultiLineTextSnippetDirectAnswer` and `RichTextSnippetDirectAnswer` as a featured snippet direct answer can only be of fieldType `multi_line_text` or `rich_text`. (#207 #212 ) - All exports marked as `@deprecated` in previous version(s) as part of the rebranding process is now removed in V2 (#216 ) - For more details, the deprecated identifiers are listed in [v1.8 release notes](https://github.com/yext/search-core/releases/tag/v1.8.0)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MultiLineTextFeaturedSnippetDirectAnswerandRichTextFeaturedSnippetDirectAnswerfor the two types that fieldType of featured snippet direct answer can be.multi_line_textfor feature snippet DA have non optionalvaluefield of type stringrich_textfor feature snippet DA does not havevaluefield so that is omitted in the interfaceFeaturedSnippetDirectAnsweris now the base interfaceBaseFeaturedSnippetDirectAnswerthat the specific interfaces extend from. The newFeaturedSnippetDirectAnsweris the union type.J=SLAP-2330
TEST=auto&manual
oshi confirmed the structure of multi_line_text and rich_text through examples listed in the comments under this item where rich_text does NOT provide
valuefield andmulti_line_textdoes.tested locally that:
- 'value' field is present, of type string, and NOT optional in IDE for the switch case 'multi_line_text'