create AddressDirectAnswer interface #203

juliannzhou · 2022-08-12T20:35:06Z

This PR creates AddressDirectAnswer interface for direct answers with address values and an address type to define generic type variable.

J=SLAP-2310
TEST=manual

Test: created a test interface with AddressDirectAnswer and works as expected for when inputting address type values. The Address type interface is generated by CLI types command for Address field of Person entity. All address fields are verified by checking api response in Search except for sublocality, region, and line 3, as I cannot find a search result that returns an address direct answer with these three fields.

coveralls · 2022-08-12T20:36:31Z

Pull Request Test Coverage Report for Build 2870583232

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 90.408%

Totals
Change from base Build 2869609543:	0.0%
Covered Lines:	214
Relevant Lines:	231

💛 - Coveralls

src/models/searchservice/response/AddressDirectAnswer.ts

oshi97 · 2022-08-15T15:10:43Z

src/models/searchservice/response/AddressDirectAnswer.ts

+}
+
+/**
+ * A type interface with address fields to use in {@link FieldValueDirectAnswer.value}.


I think we can omit telling people this is a type interface, it's obvious just looking at it!

nmanu1 · 2022-08-15T15:14:54Z

src/models/searchservice/response/AddressDirectAnswer.ts

+import { BuiltInFieldType } from './BuiltInFieldType';
+
+/**
+ * An interface for direct answers for a {@link FieldValueDirectAnswer} with address values.


this is a little wordy. I think it can be simplified by removing the first part ("An interface for direct answers for")

oshi97 · 2022-08-15T15:31:50Z

src/models/searchservice/response/AddressDirectAnswer.ts

+ *
+ * @public
+ */
+export interface Address {


Out of curiosity are all of these properties truly optional?

what do the yext types generate answers types say? these are technically different types but for Address I would assume they match up.

separate note: At least one of these properties must be not-undefined, otherwise we would never get a direct answer, but I don't think there's a good way to represent that through typescript

I tested it out on slanswers-test experience and I think line 1, city, region, and postalCode are required, although they are generated through CLI as optionals.

What makes you think they're required?

When you add address to a person or a location, these fields are required.

nmanu1 · 2022-08-15T18:27:52Z

src/models/searchservice/response/AddressDirectAnswer.ts

+import { DirectAnswer } from './directanswer/DirectAnswer';
+
+/**
+ * A direct answer {@link DirectAnswer} interface with address value.


can this be reworded? right now, the text would read "A direct answer DirectAnswer interface with ..."

oshi97 · 2022-08-15T18:39:56Z

@juliannzhou what queries did you try? I wanted to try poking around as well

juliannzhou · 2022-08-15T18:59:09Z

@juliannzhou what queries did you try? I wanted to try poking around as well

I did 'yen address', 'bob address', 'event address', 'yext address'

oshi97 · 2022-08-15T21:59:33Z

We need to add your new DirectAnswer interface to the FieldValueDirectAnswer union type. You can look at my pr as an example #208
If you want you can wait for my pr to be merged in, and then use the test-site infra I wrote

oshi97 · 2022-08-16T14:43:45Z

Could you add to the test-site's initDirectAnswer switch case?

yen-tt · 2022-08-16T16:01:10Z

src/models/searchservice/response/directanswer/fieldvaluedirectanswers/AddressDirectAnswer.ts

+  sublocality?: string,
+  city: string,
+  region: string,
+  postalCode: string,


I'm not certain if all non US areas would have postal code? I added a location for Bolivia to the account to test. Feel free to add a Bolivia address to something else and try it out

Alright, looks like region and postalCode is not certain. let's make them optional. Lets add your test query to the test file as well!

If we're not sure about things and composeAbstractSchema says they're all optional I don't mind just making them all optional

I would assume at least line1 should always be defined for an address? can't say the same for the other ones though.

Julianne talked to KM channel. Looks like countryCode should always be defined in practice and everything else is optional. So we should update to reflect that

yen-tt · 2022-08-16T19:09:00Z

src/models/searchservice/response/directanswer/fieldvaluedirectanswers/AddressDirectAnswer.ts

+ *
+ * @public
+ */
+export interface Address {


you need to export this in the fieldvaluedirectanswer/index.ts file was well since this is part of the interface above

I think it was added in the file. Can you check again if the file changes are refreshed?

I don't see Address in the index file. Also this warning indicates it's not exported.

maybe you didn't push your new changes?

## 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)

create address direct answer

1231096

juliannzhou requested a review from a team as a code owner August 12, 2022 20:35

fix styling issue

411127b

nmanu1 reviewed Aug 15, 2022

View reviewed changes

src/models/searchservice/response/AddressDirectAnswer.ts Outdated Show resolved Hide resolved

change doc

ae2e26c

oshi97 reviewed Aug 15, 2022

View reviewed changes

nmanu1 reviewed Aug 15, 2022

View reviewed changes

oshi97 reviewed Aug 15, 2022

View reviewed changes

juliannzhou added 2 commits August 15, 2022 13:51

resolve merge conflicts

512e37b

update doc and make required

206b455

juliannzhou requested review from oshi97 and nmanu1 August 15, 2022 18:22

nmanu1 reviewed Aug 15, 2022

View reviewed changes

update doc

f28d265

juliannzhou requested a review from nmanu1 August 15, 2022 18:33

juliannzhou added 6 commits August 15, 2022 16:03

correct extend

3f60afa

rename

a860945

update doc

882b095

Merge branch 'develop' into dev/address-direct-answer

6b9f395

reorder index export

594888f

fix styling issue

32b3ee2

enum or literal

be43ee8

juliannzhou added 2 commits August 16, 2022 11:05

merge

4a08672

build

e67beea

juliannzhou force-pushed the dev/address-direct-answer branch from d616077 to e67beea Compare August 16, 2022 15:08

juliannzhou added 5 commits August 16, 2022 11:09

switch

6fa4336

remove test

90deb1e

merge

cc8f920

add union

7608f5f

union and export

7c47869

juliannzhou force-pushed the dev/address-direct-answer branch from 83214a5 to 7c47869 Compare August 16, 2022 15:38

juliannzhou added 2 commits August 16, 2022 11:40

Merge branch 'develop' into dev/address-direct-answer

db2ba64

lint

fdce0c5

yen-tt reviewed Aug 16, 2022

View reviewed changes

juliannzhou and others added 5 commits August 16, 2022 12:01

field value query

8cf3e61

make optional and add query test

fdbd15c

Merge branch 'develop' into dev/address-direct-answer

ef15cba

Automated update to repo's documentation from github action

caffe50

add union

8dda906

juliannzhou requested a review from yen-tt August 16, 2022 17:53

change required

fd790a3

juliannzhou force-pushed the dev/address-direct-answer branch from 8c592c6 to fd790a3 Compare August 16, 2022 18:54

yen-tt reviewed Aug 16, 2022

View reviewed changes

export

3062b94

juliannzhou requested a review from yen-tt August 16, 2022 19:33

yen-tt approved these changes Aug 16, 2022

View reviewed changes

juliannzhou merged commit f159737 into develop Aug 16, 2022

juliannzhou deleted the dev/address-direct-answer branch August 16, 2022 19:56

yen-tt mentioned this pull request Sep 6, 2022

Version 2.0.0 #222

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

create AddressDirectAnswer interface #203

create AddressDirectAnswer interface #203

juliannzhou commented Aug 12, 2022 •

edited

Loading

coveralls commented Aug 12, 2022 •

edited

Loading

oshi97 Aug 15, 2022 •

edited

Loading

nmanu1 Aug 15, 2022

oshi97 Aug 15, 2022

oshi97 Aug 15, 2022

juliannzhou Aug 15, 2022

oshi97 Aug 15, 2022

juliannzhou Aug 15, 2022

nmanu1 Aug 15, 2022

oshi97 commented Aug 15, 2022 •

edited

Loading

juliannzhou commented Aug 15, 2022

oshi97 commented Aug 15, 2022

oshi97 commented Aug 16, 2022

yen-tt Aug 16, 2022 •

edited

Loading

yen-tt Aug 16, 2022 •

edited

Loading

oshi97 Aug 16, 2022 •

edited

Loading

yen-tt Aug 16, 2022

yen-tt Aug 16, 2022

yen-tt Aug 16, 2022

juliannzhou Aug 16, 2022

yen-tt Aug 16, 2022

yen-tt Aug 16, 2022

juliannzhou Aug 16, 2022

create AddressDirectAnswer interface #203

create AddressDirectAnswer interface #203

Conversation

juliannzhou commented Aug 12, 2022 • edited Loading

coveralls commented Aug 12, 2022 • edited Loading

Pull Request Test Coverage Report for Build 2870583232

💛 - Coveralls

oshi97 Aug 15, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oshi97 commented Aug 15, 2022 • edited Loading

juliannzhou commented Aug 15, 2022

oshi97 commented Aug 15, 2022

oshi97 commented Aug 16, 2022

yen-tt Aug 16, 2022 • edited Loading

Choose a reason for hiding this comment

yen-tt Aug 16, 2022 • edited Loading

Choose a reason for hiding this comment

oshi97 Aug 16, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juliannzhou commented Aug 12, 2022 •

edited

Loading

coveralls commented Aug 12, 2022 •

edited

Loading

oshi97 Aug 15, 2022 •

edited

Loading

oshi97 commented Aug 15, 2022 •

edited

Loading

yen-tt Aug 16, 2022 •

edited

Loading

yen-tt Aug 16, 2022 •

edited

Loading

oshi97 Aug 16, 2022 •

edited

Loading