support env, region, and endpoints (#16)

updated config to expose env, region and endpoints field to customize/override the default URLs to make requests to.

J=CLIP-288
TEST=manual&auto

see that chat endpoint works with clippy EU prod and US dev account using test-site.
see that jest tests passed

docs/chat-core.chatconfig.endpoints.md

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

docs/chat-core.chatconfig.env.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [ChatConfig](./chat-core.chatconfig.md) &gt; [env](./chat-core.chatconfig.env.md)
+
+## ChatConfig.env property
+
+Defines the environment of the API domains.
+
+**Signature:**
+
+```typescript
+env?: EnumOrLiteral<Environment>;
+```
+
+## Remarks
+
+Default to PROD.
+

docs/chat-core.chatconfig.md

@@ -16,9 +16,11 @@ export interface ChatConfig
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [apiDomain?](./chat-core.chatconfig.apidomain.md) |  | string | _(Optional)_ Domain to use for the URL endpoints. |
 |  [apiKey](./chat-core.chatconfig.apikey.md) |  | string | The api key of the Chat experience. |
 |  [botId](./chat-core.chatconfig.botid.md) |  | string | ID of the bot to interface with. |
 |  [businessId?](./chat-core.chatconfig.businessid.md) |  | number | _(Optional)_ ID of the account associated with this chat bot. |
+|  [endpoints?](./chat-core.chatconfig.endpoints.md) |  | [Endpoints](./chat-core.endpoints.md) | _(Optional)_ Overrides for the URLs which are used when making requests to the Chat API. |
+|  [env?](./chat-core.chatconfig.env.md) |  | [EnumOrLiteral](./chat-core.enumorliteral.md)<!-- -->&lt;[Environment](./chat-core.environment.md)<!-- -->&gt; | _(Optional)_ Defines the environment of the API domains. |
+|  [region?](./chat-core.chatconfig.region.md) |  | [EnumOrLiteral](./chat-core.enumorliteral.md)<!-- -->&lt;[Region](./chat-core.region.md)<!-- -->&gt; | _(Optional)_ The region to send the requests to. |
 |  [version?](./chat-core.chatconfig.version.md) |  | "STAGING" \| "PRODUCTION" \| number | _(Optional)_ The version of the chat bot configuration. |
 

docs/chat-core.chatconfig.region.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [ChatConfig](./chat-core.chatconfig.md) &gt; [region](./chat-core.chatconfig.region.md)
+
+## ChatConfig.region property
+
+The region to send the requests to.
+
+**Signature:**
+
+```typescript
+region?: EnumOrLiteral<Region>;
+```
+
+## Remarks
+
+Defaults to 'US'.
+

docs/chat-core.chatconfig.version.md

@@ -14,7 +14,7 @@ version?: "STAGING" | "PRODUCTION" | number;
 
 ## Remarks
 
-May be a configuration label (string) or a configuration version (number). Default to 'STAGING'
+May be a configuration label (string) or a configuration version (number). Default to 'STAGING' in Chat API
 
 ## Example
 

docs/chat-core.endpoints.chat.md

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

docs/chat-core.endpoints.chatstream.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Endpoints](./chat-core.endpoints.md) &gt; [chatStream](./chat-core.endpoints.chatstream.md)
+
+## Endpoints.chatStream property
+
+Chat streaming API endpoint.
+
+**Signature:**
+
+```typescript
+chatStream: string;
+```

docs/chat-core.endpoints.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Endpoints](./chat-core.endpoints.md)
+
+## Endpoints interface
+
+The URLs which are used when making requests to the Chat API.
+
+**Signature:**
+
+```typescript
+export interface Endpoints 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [chat](./chat-core.endpoints.chat.md) |  | string | Chat API endpoint. |
+|  [chatStream](./chat-core.endpoints.chatstream.md) |  | string | Chat streaming API endpoint. |
+

docs/chat-core.environment.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Environment](./chat-core.environment.md)
+
+## Environment enum
+
+Defines the environment of the API domains.
+
+**Signature:**
+
+```typescript
+export declare enum Environment 
+```
+
+## Enumeration Members
+
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  PROD | <code>&quot;prod&quot;</code> |  |
+|  SANDBOX | <code>&quot;sbx&quot;</code> |  |
+

docs/chat-core.md

@@ -15,7 +15,9 @@
 
 |  Enumeration | Description |
 |  --- | --- |
+|  [Environment](./chat-core.environment.md) | Defines the environment of the API domains. |
 |  [MessageSource](./chat-core.messagesource.md) | Types of sender of a message. |
+|  [Region](./chat-core.region.md) | The region to send the requests to. |
 |  [StreamEventName](./chat-core.streameventname.md) | Names of stream events returned from Chat Stream API. |
 
 ## Interfaces
@@ -24,6 +26,7 @@
 |  --- | --- |
 |  [ChatConfig](./chat-core.chatconfig.md) | The configuration options for [ChatCore](./chat-core.chatcore.md)<!-- -->. |
 |  [EndEvent](./chat-core.endevent.md) | An event that indicates end of Chat stream. |
+|  [Endpoints](./chat-core.endpoints.md) | The URLs which are used when making requests to the Chat API. |
 |  [Message](./chat-core.message.md) | Represents a message within a conversation. |
 |  [MessageNotes](./chat-core.messagenotes.md) | Information relevant to the current state of the conversation, serving as the bot’s "memory" regarding what work it previously did to help determine future actions. |
 |  [MessageRequest](./chat-core.messagerequest.md) | A request to Chat API. |

docs/chat-core.region.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Region](./chat-core.region.md)
+
+## Region enum
+
+The region to send the requests to.
+
+**Signature:**
+
+```typescript
+export declare enum Region 
+```
+
+## Enumeration Members
+
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  EU | <code>&quot;eu&quot;</code> |  |
+|  US | <code>&quot;us&quot;</code> |  |
+

etc/chat-core.api.md

@@ -8,10 +8,12 @@ import { Response as Response_2 } from 'node-fetch';
 
 // @public
 export interface ChatConfig {
-    apiDomain?: string;
     apiKey: string;
     botId: string;
     businessId?: number;
+    endpoints?: Endpoints;
+    env?: EnumOrLiteral<Environment>;
+    region?: EnumOrLiteral<Region>;
     version?: "STAGING" | "PRODUCTION" | number;
 }
 
@@ -28,9 +30,23 @@ export interface EndEvent {
     event: EnumOrLiteral<StreamEventName.EndEvent>;
 }
 
+// @public
+export interface Endpoints {
+    chat: string;
+    chatStream: string;
+}
+
 // @public
 export type EnumOrLiteral<T extends string> = T | `${T}`;
 
+// @public
+export enum Environment {
+    // (undocumented)
+    PROD = "prod",
+    // (undocumented)
+    SANDBOX = "sbx"
+}
+
 // @public
 export interface Message {
     responseId?: string;
@@ -73,6 +89,14 @@ export enum MessageSource {
 // @public
 export type RawResponse = Response | Response_2;
 
+// @public
+export enum Region {
+    // (undocumented)
+    EU = "eu",
+    // (undocumented)
+    US = "us"
+}
+
 // @public
 export interface StartEvent {
     data: MessageNotes;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yext/chat-core",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "description": "Typescript Networking Library for the Yext Chat API",
   "main": "./dist/commonjs/index.js",
   "module": "./dist/esm/index.js",

src/ChatCore.ts

@@ -1,7 +1,9 @@
-import { defaultApiDomain, defaultApiVersion } from "./constants";
+import { defaultApiVersion } from "./constants";
 import { HttpService } from "./http/HttpService";
+import { EndpointsFactory } from "./infra/EndpointsFactory";
 import { StreamResponse } from "./infra/StreamResponse";
 import { ChatConfig, MessageRequest, MessageResponse } from "./models";
+import { Endpoints } from "./models/endpoints/Endpoints";
 import { ApiMessageRequest } from "./models/endpoints/MessageRequest";
 import { ApiResponse } from "./models/http/ApiResponse";
 import { QueryParams } from "./models/http/params";
@@ -15,22 +17,13 @@ import { ApiResponseValidator } from "./validation/ApiResponseValidator";
 export class ChatCore {
   private chatConfig: ChatConfig;
   private httpService: HttpService;
+  private endpoints: Endpoints;
 
   constructor(chatConfig: ChatConfig) {
     this.chatConfig = chatConfig;
     this.httpService = new HttpService();
-  }
-
-  private getUrl({ businessId, botId, apiDomain }: ChatConfig) {
-    return `https://${apiDomain || defaultApiDomain}/v2/accounts/${
-      businessId || "me"
-    }/chat/${botId}/message`;
-  }
-
-  private getStreamUrl({ businessId, botId, apiDomain }: ChatConfig) {
-    return `https://${apiDomain || defaultApiDomain}/v2/accounts/${
-      businessId || "me"
-    }/chat/${botId}/message/streaming`;
+    this.endpoints =
+      chatConfig.endpoints ?? EndpointsFactory.getEndpoints(this.chatConfig);
   }
 
   /**
@@ -48,7 +41,7 @@ export class ChatCore {
       version: this.chatConfig.version,
     };
     const rawResponse = await this.httpService.post(
-      this.getUrl(this.chatConfig),
+      this.endpoints.chat,
       queryParams,
       body,
       this.chatConfig.apiKey
@@ -77,7 +70,7 @@ export class ChatCore {
   /**
    * Make a request to Chat streaming API to generate the next message
    * and consume its tokens via server-sent events.
-   * 
+   *
    * @experimental
    *
    * @remarks
@@ -92,7 +85,7 @@ export class ChatCore {
       version: this.chatConfig.version,
     };
     const rawResponse = await this.httpService.post(
-      this.getStreamUrl(this.chatConfig),
+      this.endpoints.chatStream,
       queryParams,
       body,
       this.chatConfig.apiKey

src/constants.ts

@@ -1,2 +1 @@
 export const defaultApiVersion = 20230101;
-export const defaultApiDomain = "liveapi.yext.com";

src/infra/EndpointsFactory.ts

@@ -0,0 +1,43 @@
+import { Region } from "../models/endpoints/Region";
+import { EndpointConfig } from "../models/endpoints/EndpointConfig";
+import { Endpoints } from "../models/endpoints/Endpoints";
+import { Environment } from "../models/endpoints/Environment";
+
+/**
+ * Provides methods for getting various endpoints.
+ *
+ * @internal
+ */
+export class EndpointsFactory {
+  private static getDomain(endpointConfig: EndpointConfig): string {
+    const { region = Region.US, env = Environment.PROD } = endpointConfig;
+    switch (region) {
+      case Region.US:
+        return env === Environment.PROD
+          ? "liveapi.yext.com"
+          : `liveapi-${env}.yext.com`;
+      case Region.EU:
+        if (env === Environment.PROD) {
+          return "cdn.eu.yextapis.com";
+        }
+        throw new Error(
+          `Unsupported domain: invalid environment "${env}" for region EU`
+        );
+      default:
+        throw new Error(`Unsupported domain: unknown region "${region}"`);
+    }
+  }
+
+  public static getEndpoints(endpointConfig: EndpointConfig): Endpoints {
+    const { businessId, botId } = endpointConfig;
+    const domain = this.getDomain(endpointConfig);
+    return {
+      chat: `https://${domain}/v2/accounts/${
+        businessId || "me"
+      }/chat/${botId}/message`,
+      chatStream: `https://${domain}/v2/accounts/${
+        businessId || "me"
+      }/chat/${botId}/message/streaming`,
+    };
+  }
+}