Skip to content

Commit

Permalink
Provide Endpoints for EU Cloud Region
Browse files Browse the repository at this point in the history
This PR creates an EndpointProvider class to offer a way to get endpoints for EU.

J=BACK-2270
TEST=auto,manual

Ran tests under tests/.
Manually started a test site and made sure the api request use the correct endpoints.

Change-Id: I5c5bbd99e9c3f0f67d0b6817e0a0db6eeaf2f231
  • Loading branch information
EmilyZhang777 committed May 3, 2023
1 parent 3183412 commit db0f804
Show file tree
Hide file tree
Showing 28 changed files with 407 additions and 52 deletions.
12 changes: 12 additions & 0 deletions THIRD-PARTY-NOTICES
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,18 @@ This package contains the following license and notice below:

-----------

The following NPM package may be included in this product:

- tsc@2.0.4

This package contains the following license and notice below:

## DEPRECATED.

Use [`typescript`](https://www.npmjs.com/package/typescript) to get access to the `tsc` CLI command.

-----------

The following NPM package may be included in this product:

- webidl-conversions@3.0.1
Expand Down
2 changes: 1 addition & 1 deletion docs/search-core.context.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers
<b>Signature:</b>

```typescript
export declare type Context = any;
export type Context = any;
```

## Remarks
Expand Down
22 changes: 22 additions & 0 deletions docs/search-core.endpointsprovider._constructor_.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [(constructor)](./search-core.endpointsprovider._constructor_.md)

## EndpointsProvider.(constructor)

Constructs a new instance of the `EndpointsProvider` class

<b>Signature:</b>

```typescript
constructor(environment?: Environment, cloudRegion?: CloudRegion, overrideEndpoints?: Endpoints);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| environment | Environment | |
| cloudRegion | CloudRegion | |
| overrideEndpoints | [Endpoints](./search-core.endpoints.md) | |

29 changes: 29 additions & 0 deletions docs/search-core.endpointsprovider.getendpoints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getEndpoints](./search-core.endpointsprovider.getendpoints.md)

## EndpointsProvider.getEndpoints() method

Provides all endpoints based on environment and cloud region. Include any custom overrides in overrideEndpoints.

<b>Signature:</b>

```typescript
getEndpoints(): {
universalSearch: string;
verticalSearch: string;
questionSubmission: string;
status: string;
universalAutocomplete: string;
verticalAutocomplete: string;
filterSearch: string;
};
```
<b>Returns:</b>

{ universalSearch: string; verticalSearch: string; questionSubmission: string; status: string; universalAutocomplete: string; verticalAutocomplete: string; filterSearch: string; }

## Remarks

Returns an [Endpoints](./search-core.endpoints.md) instance.

17 changes: 17 additions & 0 deletions docs/search-core.endpointsprovider.getfiltersearchendpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getFilterSearchEndpoint](./search-core.endpointsprovider.getfiltersearchendpoint.md)

## EndpointsProvider.getFilterSearchEndpoint() method

Returns the endpoint for filter search.

<b>Signature:</b>

```typescript
getFilterSearchEndpoint(): string;
```
<b>Returns:</b>

string

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getQuestionSubmissionEndpoint](./search-core.endpointsprovider.getquestionsubmissionendpoint.md)

## EndpointsProvider.getQuestionSubmissionEndpoint() method

Returns the endpoint for question submission.

<b>Signature:</b>

```typescript
getQuestionSubmissionEndpoint(): string;
```
<b>Returns:</b>

string

17 changes: 17 additions & 0 deletions docs/search-core.endpointsprovider.getstatusendpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getStatusEndpoint](./search-core.endpointsprovider.getstatusendpoint.md)

## EndpointsProvider.getStatusEndpoint() method

Returns the endpoint for status.

<b>Signature:</b>

```typescript
getStatusEndpoint(): string;
```
<b>Returns:</b>

string

17 changes: 17 additions & 0 deletions docs/search-core.endpointsprovider.getuniversalautocomplete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getUniversalAutocomplete](./search-core.endpointsprovider.getuniversalautocomplete.md)

## EndpointsProvider.getUniversalAutocomplete() method

Returns the endpoint for universal autocomplete.

<b>Signature:</b>

```typescript
getUniversalAutocomplete(): string;
```
<b>Returns:</b>

string

17 changes: 17 additions & 0 deletions docs/search-core.endpointsprovider.getuniversalsearchendpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getUniversalSearchEndpoint](./search-core.endpointsprovider.getuniversalsearchendpoint.md)

## EndpointsProvider.getUniversalSearchEndpoint() method

Returns the endpoint for universal search.

<b>Signature:</b>

```typescript
getUniversalSearchEndpoint(): string;
```
<b>Returns:</b>

string

17 changes: 17 additions & 0 deletions docs/search-core.endpointsprovider.getverticalautocomplete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getVerticalAutocomplete](./search-core.endpointsprovider.getverticalautocomplete.md)

## EndpointsProvider.getVerticalAutocomplete() method

Returns the endpoint for vertical autocomplete.

<b>Signature:</b>

```typescript
getVerticalAutocomplete(): string;
```
<b>Returns:</b>

string

17 changes: 17 additions & 0 deletions docs/search-core.endpointsprovider.getverticalsearchendpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getVerticalSearchEndpoint](./search-core.endpointsprovider.getverticalsearchendpoint.md)

## EndpointsProvider.getVerticalSearchEndpoint() method

Returns the endpoint for vertical search.

<b>Signature:</b>

```typescript
getVerticalSearchEndpoint(): string;
```
<b>Returns:</b>

string

33 changes: 33 additions & 0 deletions docs/search-core.endpointsprovider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md)

## EndpointsProvider class

Provides methods for getting various endpoints.

<b>Signature:</b>

```typescript
export declare class EndpointsProvider
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(environment, cloudRegion, overrideEndpoints)](./search-core.endpointsprovider._constructor_.md) | | Constructs a new instance of the <code>EndpointsProvider</code> class |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [getEndpoints()](./search-core.endpointsprovider.getendpoints.md) | | Provides all endpoints based on environment and cloud region. Include any custom overrides in overrideEndpoints. |
| [getFilterSearchEndpoint()](./search-core.endpointsprovider.getfiltersearchendpoint.md) | | Returns the endpoint for filter search. |
| [getQuestionSubmissionEndpoint()](./search-core.endpointsprovider.getquestionsubmissionendpoint.md) | | Returns the endpoint for question submission. |
| [getStatusEndpoint()](./search-core.endpointsprovider.getstatusendpoint.md) | | Returns the endpoint for status. |
| [getUniversalAutocomplete()](./search-core.endpointsprovider.getuniversalautocomplete.md) | | Returns the endpoint for universal autocomplete. |
| [getUniversalSearchEndpoint()](./search-core.endpointsprovider.getuniversalsearchendpoint.md) | | Returns the endpoint for universal search. |
| [getVerticalAutocomplete()](./search-core.endpointsprovider.getverticalautocomplete.md) | | Returns the endpoint for vertical autocomplete. |
| [getVerticalSearchEndpoint()](./search-core.endpointsprovider.getverticalsearchendpoint.md) | | Returns the endpoint for vertical search. |

2 changes: 1 addition & 1 deletion docs/search-core.enumorliteral.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Produces a union type from the enum passed as a generic which consists of the en
<b>Signature:</b>

```typescript
export declare type EnumOrLiteral<T extends string> = T | `${T}`;
export type EnumOrLiteral<T extends string> = T | `${T}`;
```
2 changes: 1 addition & 1 deletion docs/search-core.featuredsnippetdirectanswer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ All possible built-in [BaseFeaturedSnippetDirectAnswer](./search-core.basefeatur
<b>Signature:</b>

```typescript
export declare type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
export type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
```
<b>References:</b> [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md)<!-- -->, [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md)

2 changes: 1 addition & 1 deletion docs/search-core.fieldvaluedirectanswer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Possible built-in and custom [BaseFieldValueDirectAnswer](./search-core.basefiel
<b>Signature:</b>

```typescript
export declare type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer | PhoneDirectAnswer | EmailDirectAnswer | AddressDirectAnswer | HoursDirectAnswer;
export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer | PhoneDirectAnswer | EmailDirectAnswer | AddressDirectAnswer | HoursDirectAnswer;
```
<b>References:</b> [UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.md)<!-- -->, [TextDirectAnswer](./search-core.textdirectanswer.md)<!-- -->, [UrlDirectAnswer](./search-core.urldirectanswer.md)<!-- -->, [RichTextDirectAnswer](./search-core.richtextdirectanswer.md)<!-- -->, [DecimalDirectAnswer](./search-core.decimaldirectanswer.md)<!-- -->, [FacebookUrlDirectAnswer](./search-core.facebookurldirectanswer.md)<!-- -->, [InstagramHandleDirectAnswer](./search-core.instagramhandledirectanswer.md)<!-- -->, [TwitterHandleDirectAnswer](./search-core.twitterhandledirectanswer.md)<!-- -->, [IosAppUrlDirectAnswer](./search-core.iosappurldirectanswer.md)<!-- -->, [AndroidAppUrlDirectAnswer](./search-core.androidappurldirectanswer.md)<!-- -->, [ComplexUrlDirectAnswer](./search-core.complexurldirectanswer.md)<!-- -->, [IntegerDirectAnswer](./search-core.integerdirectanswer.md)<!-- -->, [PhoneDirectAnswer](./search-core.phonedirectanswer.md)<!-- -->, [EmailDirectAnswer](./search-core.emaildirectanswer.md)<!-- -->, [AddressDirectAnswer](./search-core.addressdirectanswer.md)<!-- -->, [HoursDirectAnswer](./search-core.hoursdirectanswer.md)

2 changes: 1 addition & 1 deletion docs/search-core.highlightedfields.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A mapping of fields to the values emphasized by the Search API.
<b>Signature:</b>

```typescript
export declare type HighlightedFields = {
export type HighlightedFields = {
[fieldId: string]: HighlightedValue | HighlightedValue[] | HighlightedFields | HighlightedFields[];
};
```
Expand Down
1 change: 1 addition & 0 deletions docs/search-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

| Class | Description |
| --- | --- |
| [EndpointsProvider](./search-core.endpointsprovider.md) | Provides methods for getting various endpoints. |
| [SearchCore](./search-core.searchcore.md) | Provides methods for executing searches, submitting questions, and performing autocompletes. |
| [SearchError](./search-core.searcherror.md) | Represents an error |

Expand Down
5 changes: 5 additions & 0 deletions docs/search-core.sandboxendpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@

## SandboxEndpoints variable

> Warning: This API is now obsolete.
>
> Use [EndpointsProvider](./search-core.endpointsprovider.md) instead
>
The endpoints to use for sandbox experiences.

<b>Signature:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/search-core.searchconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The main configuration options for [SearchCore](./search-core.searchcore.md)<!--
<b>Signature:</b>

```typescript
export declare type SearchConfig = SearchConfigWithApiKey | SearchConfigWithToken;
export type SearchConfig = SearchConfigWithApiKey | SearchConfigWithToken;
```
<b>References:</b> [SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md)<!-- -->, [SearchConfigWithToken](./search-core.searchconfigwithtoken.md)

2 changes: 1 addition & 1 deletion docs/search-core.staticfilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Represents a static filter that will be used to refine results.
<b>Signature:</b>

```typescript
export declare type StaticFilter = FieldValueStaticFilter | DisjunctionStaticFilter | ConjunctionStaticFilter;
export type StaticFilter = FieldValueStaticFilter | DisjunctionStaticFilter | ConjunctionStaticFilter;
```
<b>References:</b> [FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md)<!-- -->, [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md)<!-- -->, [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md)

27 changes: 26 additions & 1 deletion etc/search-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,31 @@ export interface Endpoints {
verticalSearch?: string;
}

// @public
export class EndpointsProvider {
// Warning: (ae-forgotten-export) The symbol "Environment" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "CloudRegion" needs to be exported by the entry point index.d.ts
constructor(environment?: Environment, cloudRegion?: CloudRegion, overrideEndpoints?: Endpoints);
// @internal (undocumented)
getDomain(): string;
getEndpoints(): {
universalSearch: string;
verticalSearch: string;
questionSubmission: string;
status: string;
universalAutocomplete: string;
verticalAutocomplete: string;
filterSearch: string;
};
getFilterSearchEndpoint(): string;
getQuestionSubmissionEndpoint(): string;
getStatusEndpoint(): string;
getUniversalAutocomplete(): string;
getUniversalSearchEndpoint(): string;
getVerticalAutocomplete(): string;
getVerticalSearchEndpoint(): string;
}

// @public
export type EnumOrLiteral<T extends string> = T | `${T}`;

Expand Down Expand Up @@ -581,7 +606,7 @@ export interface RichTextSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDir
fieldType: EnumOrLiteral<BuiltInFieldType.RichText>;
}

// @public
// @public @deprecated
export const SandboxEndpoints: Required<Endpoints>;

// @public
Expand Down

0 comments on commit db0f804

Please sign in to comment.