chat-core: support zendeskHandoff field (#46)

chat-core: support zendeskHandoff field #46

packages/chat-core-aws-connect/THIRD-PARTY-NOTICES

@@ -195,7 +195,7 @@ The following NPM packages may be included in this product:
  - @types/istanbul-lib-report@3.0.3
  - @types/istanbul-reports@3.0.4
  - @types/jsdom@20.0.1
- - @types/node@22.5.0
+ - @types/node@22.5.4
  - @types/stack-utils@2.0.3
  - @types/tough-cookie@4.0.5
  - @types/yargs-parser@21.0.3
@@ -321,7 +321,7 @@ THE SOFTWARE.
 
 The following NPM package may be included in this product:
 
- - acorn-walk@8.3.3
+ - acorn-walk@8.3.4
 
 This package contains the following license and notice below:
 
@@ -1024,7 +1024,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 The following NPM package may be included in this product:
 
- - debug@4.3.6
+ - debug@4.3.7
 
 This package contains the following license and notice below:
 
@@ -1803,13 +1803,13 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 The following NPM package may be included in this product:
 
- - ms@2.1.2
+ - ms@2.1.3
 
 This package contains the following license and notice below:
 
 The MIT License (MIT)
 
-Copyright (c) 2016 Zeit, Inc.
+Copyright (c) 2020 Vercel, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -1922,13 +1922,13 @@ THE SOFTWARE.
 
 The following NPM package may be included in this product:
 
- - picocolors@1.0.1
+ - picocolors@1.1.0
 
 This package contains the following license and notice below:
 
 ISC License
 
-Copyright (c) 2021 Alexey Raspopov, Kostiantyn Denysov, Anton Verinov
+Copyright (c) 2021-2024 Oleksii Raspopov, Kostiantyn Denysov, Anton Verinov
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

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

@@ -21,4 +21,5 @@ This is only present when the conversation is integrated with a third-party serv
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [awsConnectHandoff?](./chat-core.integrationdetails.awsconnecthandoff.md) |  | [AwsConnectHandoff](./chat-core.awsconnecthandoff.md) | _(Optional)_ Configurations for AWS Connect handoff. |
+|  [zendeskHandoff?](./chat-core.integrationdetails.zendeskhandoff.md) |  | [ZendeskHandoff](./chat-core.zendeskhandoff.md) | _(Optional)_ Configurations for Zendesk handoff. |
 

packages/chat-core/docs/chat-core.integrationdetails.zendeskhandoff.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; [zendeskHandoff](./chat-core.integrationdetails.zendeskhandoff.md)
+
+## IntegrationDetails.zendeskHandoff property
+
+Configurations for Zendesk handoff.
+
+**Signature:**
+
+```typescript
+zendeskHandoff?: ZendeskHandoff;
+```

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

@@ -44,6 +44,7 @@
 |  [StartEvent](./chat-core.startevent.md) | An event that indicates start of Chat stream. |
 |  [TokenStreamData](./chat-core.tokenstreamdata.md) | Data returned from a [TokenStreamEvent](./chat-core.tokenstreamevent.md)<!-- -->. |
 |  [TokenStreamEvent](./chat-core.tokenstreamevent.md) | An event that carries a partial response. |
+|  [ZendeskHandoff](./chat-core.zendeskhandoff.md) | Configurations for Zendesk handoff. |
 
 ## Type Aliases
 

packages/chat-core/docs/chat-core.zendeskhandoff.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; [ZendeskHandoff](./chat-core.zendeskhandoff.md)
+
+## ZendeskHandoff interface
+
+Configurations for Zendesk handoff.
+
+**Signature:**
+
+```typescript
+export interface ZendeskHandoff 
+```

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

@@ -77,6 +77,7 @@ export enum Environment {
 // @public
 export interface IntegrationDetails {
     awsConnectHandoff?: AwsConnectHandoff;
+    zendeskHandoff?: ZendeskHandoff;
 }
 
 // Warning: (ae-internal-missing-underscore) The name "InternalConfig" should be prefixed with an underscore because the declaration is marked as @internal
@@ -188,6 +189,10 @@ export interface TokenStreamEvent {
     event: EnumOrLiteral<StreamEventName.TokenStreamEvent>;
 }
 
+// @public
+export interface ZendeskHandoff {
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

packages/chat-core/package.json

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

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

@@ -26,8 +26,8 @@ export { StreamEventCallback } from "./endpoints/stream/StreamEventCallback";
 export { EnumOrLiteral } from "./utils/EnumOrLiteral";
 
 export { IntegrationDetails } from "./integrations/IntegrationDetails";
-
 export {
   AwsConnectHandoff,
   AwsConnectCredentials,
 } from "./integrations/AwsConnect";
+export { ZendeskHandoff } from "./integrations/Zendesk";

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

@@ -1,4 +1,5 @@
 import { AwsConnectHandoff } from "./AwsConnect";
+import { ZendeskHandoff } from "./Zendesk";
 
 /**
  * Integration details for the current conversation.
@@ -11,4 +12,6 @@ import { AwsConnectHandoff } from "./AwsConnect";
 export interface IntegrationDetails {
   /** {@inheritdoc AwsConnectHandoff} */
   awsConnectHandoff?: AwsConnectHandoff;
+  /** {@inheritdoc ZendeskHandoff} */
+  zendeskHandoff?: ZendeskHandoff;
 }

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

@@ -0,0 +1,7 @@
+/**
+ * Configurations for Zendesk handoff.
+ *
+ * @public
+ */
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface ZendeskHandoff {}