chat-core: support integrationDetails and conversationSummary field

packages/chat-core/docs/chat-core.awsconnectcredentials.contactid.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; [AwsConnectCredentials](./chat-core.awsconnectcredentials.md) &gt; [contactId](./chat-core.awsconnectcredentials.contactid.md)
+
+## AwsConnectCredentials.contactId property
+
+The identifier of an AWS chat session.
+
+**Signature:**
+
+```typescript
+contactId: string;
+```

packages/chat-core/docs/chat-core.awsconnectcredentials.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [AwsConnectCredentials](./chat-core.awsconnectcredentials.md)
+
+## AwsConnectCredentials interface
+
+AWS Connect handoff credentials.
+
+**Signature:**
+
+```typescript
+export interface AwsConnectCredentials 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [contactId](./chat-core.awsconnectcredentials.contactid.md) |  | string | The identifier of an AWS chat session. |
+|  [participantId](./chat-core.awsconnectcredentials.participantid.md) |  | string | The identifier for a chat participant in AWS Connect. |
+|  [participantToken](./chat-core.awsconnectcredentials.participanttoken.md) |  | string | The token used by the chat participant create connection. |
+

packages/chat-core/docs/chat-core.awsconnectcredentials.participantid.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; [AwsConnectCredentials](./chat-core.awsconnectcredentials.md) &gt; [participantId](./chat-core.awsconnectcredentials.participantid.md)
+
+## AwsConnectCredentials.participantId property
+
+The identifier for a chat participant in AWS Connect.
+
+**Signature:**
+
+```typescript
+participantId: string;
+```

packages/chat-core/docs/chat-core.awsconnectcredentials.participanttoken.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; [AwsConnectCredentials](./chat-core.awsconnectcredentials.md) &gt; [participantToken](./chat-core.awsconnectcredentials.participanttoken.md)
+
+## AwsConnectCredentials.participantToken property
+
+The token used by the chat participant create connection.
+
+**Signature:**
+
+```typescript
+participantToken: string;
+```
+
+## Remarks
+
+The participant token is valid for the lifetime of a chat participant.
+

packages/chat-core/docs/chat-core.awsconnecthandoff.credentials.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; [credentials](./chat-core.awsconnecthandoff.credentials.md)
+
+## AwsConnectHandoff.credentials property
+
+AWS Connect handoff credentials.
+
+**Signature:**
+
+```typescript
+credentials: AwsConnectCredentials;
+```

packages/chat-core/docs/chat-core.awsconnecthandoff.md

@@ -0,0 +1,20 @@
+<!-- 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)
+
+## AwsConnectHandoff interface
+
+Configurations for AWS Connect handoff.
+
+**Signature:**
+
+```typescript
+export interface AwsConnectHandoff 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [credentials](./chat-core.awsconnecthandoff.credentials.md) |  | [AwsConnectCredentials](./chat-core.awsconnectcredentials.md) | AWS Connect handoff credentials. |
+

packages/chat-core/docs/chat-core.integrationdetails.awsconnecthandoff.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; [IntegrationDetails](./chat-core.integrationdetails.md) &gt; [awsConnectHandoff](./chat-core.integrationdetails.awsconnecthandoff.md)
+
+## IntegrationDetails.awsConnectHandoff property
+
+Configurations for AWS Connect handoff.
+
+**Signature:**
+
+```typescript
+awsConnectHandoff?: AwsConnectHandoff;
+```

packages/chat-core/docs/chat-core.integrationdetails.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [IntegrationDetails](./chat-core.integrationdetails.md)
+
+## IntegrationDetails interface
+
+Integration details for the current conversation.
+
+**Signature:**
+
+```typescript
+export interface IntegrationDetails 
+```
+
+## Remarks
+
+This is only present when the conversation is integrated with a third-party service, such as AWS Connect and Zendesk.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [awsConnectHandoff?](./chat-core.integrationdetails.awsconnecthandoff.md) |  | [AwsConnectHandoff](./chat-core.awsconnecthandoff.md) | _(Optional)_ Configurations for AWS Connect handoff. |
+

packages/chat-core/docs/chat-core.md

@@ -30,10 +30,13 @@
 
 |  Interface | Description |
 |  --- | --- |
+|  [AwsConnectCredentials](./chat-core.awsconnectcredentials.md) | AWS Connect handoff credentials. |
+|  [AwsConnectHandoff](./chat-core.awsconnecthandoff.md) | Configurations for AWS Connect handoff. |
 |  [ChatConfig](./chat-core.chatconfig.md) | The configuration options for [ChatCore](./chat-core.chatcore.md)<!-- -->. |
 |  [ChatCore](./chat-core.chatcore.md) | Provide methods for interacting with Chat API. |
 |  [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. |
+|  [IntegrationDetails](./chat-core.integrationdetails.md) | Integration details for the current conversation. |
 |  [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. |

packages/chat-core/docs/chat-core.messagenotes.conversationsummary.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; [MessageNotes](./chat-core.messagenotes.md) &gt; [conversationSummary](./chat-core.messagenotes.conversationsummary.md)
+
+## MessageNotes.conversationSummary property
+
+The summary of the conversation up to this point.
+
+**Signature:**
+
+```typescript
+conversationSummary?: string;
+```

packages/chat-core/docs/chat-core.messagenotes.md

@@ -21,6 +21,7 @@ This data will come from the API. As such, a user’s first request may have thi
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [collectedData?](./chat-core.messagenotes.collecteddata.md) |  | Record<string, unknown> | _(Optional)_ Data collected from user in a conversation. |
+|  [conversationSummary?](./chat-core.messagenotes.conversationsummary.md) |  | string | _(Optional)_ The summary of the conversation up to this point. |
 |  [currentGoal?](./chat-core.messagenotes.currentgoal.md) |  | string | _(Optional)_ The goal of the latest message. |
 |  [currentStepIndices?](./chat-core.messagenotes.currentstepindices.md) |  | number\[\] | _(Optional)_ The indices to traversed within the nested instruction array to access the target step. |
 |  [goalFirstMsgIndex?](./chat-core.messagenotes.goalfirstmsgindex.md) |  | number | _(Optional)_ The index of the message that started the current goal. |

packages/chat-core/docs/chat-core.messageresponse.integrationdetails.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; [MessageResponse](./chat-core.messageresponse.md) &gt; [integrationDetails](./chat-core.messageresponse.integrationdetails.md)
+
+## MessageResponse.integrationDetails property
+
+Integration details for the current conversation.
+
+**Signature:**
+
+```typescript
+integrationDetails?: IntegrationDetails;
+```
+
+## Remarks
+
+This is only present when the conversation is integrated with a third-party service, such as AWS Connect and Zendesk.
+

packages/chat-core/docs/chat-core.messageresponse.md

@@ -17,6 +17,7 @@ export interface MessageResponse
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [conversationId?](./chat-core.messageresponse.conversationid.md) |  | string | _(Optional)_ The id corresponds to the current conversation. |
+|  [integrationDetails?](./chat-core.messageresponse.integrationdetails.md) |  | [IntegrationDetails](./chat-core.integrationdetails.md) | _(Optional)_ Integration details for the current conversation. |
 |  [message](./chat-core.messageresponse.message.md) |  | [Message](./chat-core.message.md) | The generated reply to the latest message in the request. |
 |  [notes](./chat-core.messageresponse.notes.md) |  | [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. |
 

packages/chat-core/etc/chat-core.api.md

@@ -16,6 +16,18 @@ export class ApiError extends Error {
     type?: string;
 }
 
+// @public
+export interface AwsConnectCredentials {
+    contactId: string;
+    participantId: string;
+    participantToken: string;
+}
+
+// @public
+export interface AwsConnectHandoff {
+    credentials: AwsConnectCredentials;
+}
+
 // @public
 export interface ChatConfig {
     apiKey: string;
@@ -61,6 +73,11 @@ export enum Environment {
     SANDBOX = "SANDBOX"
 }
 
+// @public
+export interface IntegrationDetails {
+    awsConnectHandoff?: AwsConnectHandoff;
+}
+
 // Warning: (ae-internal-missing-underscore) The name "InternalConfig" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal
@@ -79,6 +96,7 @@ export interface Message {
 // @public
 export interface MessageNotes {
     collectedData?: Record<string, unknown>;
+    conversationSummary?: string;
     currentGoal?: string;
     currentStepIndices?: number[];
     goalFirstMsgIndex?: number;
@@ -98,6 +116,7 @@ export interface MessageRequest {
 // @public
 export interface MessageResponse {
     conversationId?: string;
+    integrationDetails?: IntegrationDetails;
     message: Message;
     notes: MessageNotes;
 }

packages/chat-core/package.json

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

packages/chat-core/src/infra/ChatCoreImpl.ts

@@ -71,6 +71,7 @@ export class ChatCoreImpl implements ChatCore {
       conversationId: data.response.conversationId,
       message: data.response.message,
       notes: data.response.notes,
+      integrationDetails: data.response.integrationDetails,
     };
   }
 

packages/chat-core/src/models/endpoints/MessageNotes.ts

@@ -23,4 +23,6 @@ export interface MessageNotes {
   goalFirstMsgIndex?: number;
   /** A set of pre-generated replies given by the AI. */
   suggestedReplies?: string[];
+  /** The summary of the conversation up to this point. */
+  conversationSummary?: string;
 }

packages/chat-core/src/models/endpoints/MessageResponse.ts

@@ -1,3 +1,4 @@
+import { IntegrationDetails } from "../integrations/IntegrationDetails";
 import { Message } from "./Message";
 import { MessageNotes } from "./MessageNotes";
 
@@ -18,4 +19,6 @@ export interface MessageResponse {
   message: Message;
   /** {@inheritDoc MessageNotes} */
   notes: MessageNotes;
+  /** {@inheritdoc IntegrationDetails} */
+  integrationDetails?: IntegrationDetails;
 }

packages/chat-core/src/models/index.ts

@@ -24,3 +24,10 @@ export { ApiError } from "./http/ApiError";
 export { StreamEventCallback } from "./endpoints/stream/StreamEventCallback";
 
 export { EnumOrLiteral } from "./utils/EnumOrLiteral";
+
+export { IntegrationDetails } from "./integrations/IntegrationDetails";
+
+export {
+  AwsConnectHandoff,
+  AwsConnectCredentials,
+} from "./integrations/AwsConnect";

packages/chat-core/src/models/integrations/AwsConnect.ts

@@ -0,0 +1,28 @@
+/**
+ * Configurations for AWS Connect handoff.
+ *
+ * @public
+ */
+export interface AwsConnectHandoff {
+  /** {@inheritdoc AwsConnectCredentials} */
+  credentials: AwsConnectCredentials;
+}
+
+/**
+ * AWS Connect handoff credentials.
+ *
+ * @public
+ */
+export interface AwsConnectCredentials {
+  /** The identifier of an AWS chat session. */
+  contactId: string;
+  /** The identifier for a chat participant in AWS Connect. */
+  participantId: string;
+  /**
+   * The token used by the chat participant create connection.
+   *
+   * @remarks
+   * The participant token is valid for the lifetime of a chat participant.
+   */
+  participantToken: string;
+}

packages/chat-core/src/models/integrations/IntegrationDetails.ts

@@ -0,0 +1,14 @@
+import { AwsConnectHandoff } from "./AwsConnect";
+
+/**
+ * Integration details for the current conversation.
+ *
+ * @public
+ *
+ * @remarks
+ * This is only present when the conversation is integrated with a third-party service, such as AWS Connect and Zendesk.
+ */
+export interface IntegrationDetails {
+  /** {@inheritdoc AwsConnectHandoff} */
+  awsConnectHandoff?: AwsConnectHandoff;
+}