chat-core: add region field to integration details section (#37)

this is required for the initialization of AWS connect chat session J=CLIP-1336 TEST=manual see that region is provided in the response through test-browser-esm site. will deploy a new patch after merge
yext · Jul 1, 2024 · dc12ae1 · dc12ae1
1 parent ee6bf54
commit dc12ae1
Show file tree

Hide file tree

Showing 9 changed files with 22 additions and 4 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/chat-core/docs/chat-core.awsconnecthandoff.md b/packages/chat-core/docs/chat-core.awsconnecthandoff.md
@@ -17,4 +17,5 @@ export interface AwsConnectHandoff
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [credentials](./chat-core.awsconnecthandoff.credentials.md) |  | [AwsConnectCredentials](./chat-core.awsconnectcredentials.md) | AWS Connect handoff credentials. |
+|  [region](./chat-core.awsconnecthandoff.region.md) |  | string | The region of The AWS Connect instance. |
 
diff --git a/packages/chat-core/docs/chat-core.awsconnecthandoff.region.md b/packages/chat-core/docs/chat-core.awsconnecthandoff.region.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; [AwsConnectHandoff](./chat-core.awsconnecthandoff.md) &gt; [region](./chat-core.awsconnecthandoff.region.md)
+
+## AwsConnectHandoff.region property
+
+The region of The AWS Connect instance.
+
+**Signature:**
+
+```typescript
+region: string;
+```
diff --git a/packages/chat-core/etc/chat-core.api.md b/packages/chat-core/etc/chat-core.api.md
@@ -26,6 +26,7 @@ export interface AwsConnectCredentials {
 // @public
 export interface AwsConnectHandoff {
     credentials: AwsConnectCredentials;
+    region: string;
 }
 
 // @public

diff --git a/packages/chat-core/package.json b/packages/chat-core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@yext/chat-core",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "Typescript Networking Library for the Yext Chat API",
   "main": "./dist/commonjs/index.js",
   "module": "./dist/esm/index.mjs",

diff --git a/packages/chat-core/src/models/integrations/AwsConnect.ts b/packages/chat-core/src/models/integrations/AwsConnect.ts
@@ -6,6 +6,8 @@
 export interface AwsConnectHandoff {
   /** {@inheritdoc AwsConnectCredentials} */
   credentials: AwsConnectCredentials;
+  /** The region of The AWS Connect instance. */
+  region: string;
 }
 
 /**

diff --git a/packages/chat-core/test-browser-esm/package-lock.json b/packages/chat-core/test-browser-esm/package-lock.json
diff --git a/packages/chat-core/test-node-cjs/package-lock.json b/packages/chat-core/test-node-cjs/package-lock.json
diff --git a/packages/chat-core/tests/ChatCore.test.ts b/packages/chat-core/tests/ChatCore.test.ts
@@ -54,6 +54,7 @@ it("returns message response on successful API response", async () => {
           participantId: "participant-id",
           participantToken: "participant-token",
         },
+        region: "us-east-1",
       },
     },
   };