From ef7d6a96ca744e7ae18ad7d5833233914ec02d50 Mon Sep 17 00:00:00 2001 From: Yen Truong <36055303+yen-tt@users.noreply.github.com> Date: Tue, 10 Sep 2024 16:47:56 -0400 Subject: [PATCH] chat-core: support `zendeskHandoff` field (#46) chat-core: support zendeskHandoff field #46 --- package-lock.json | 2 +- packages/chat-core-aws-connect/THIRD-PARTY-NOTICES | 14 +++++++------- .../chat-core/docs/chat-core.integrationdetails.md | 1 + .../chat-core.integrationdetails.zendeskhandoff.md | 13 +++++++++++++ packages/chat-core/docs/chat-core.md | 1 + .../chat-core/docs/chat-core.zendeskhandoff.md | 13 +++++++++++++ packages/chat-core/etc/chat-core.api.md | 5 +++++ packages/chat-core/package.json | 2 +- packages/chat-core/src/models/index.ts | 2 +- .../src/models/integrations/IntegrationDetails.ts | 3 +++ .../chat-core/src/models/integrations/Zendesk.ts | 7 +++++++ test-sites/test-browser-esm/package-lock.json | 6 +++--- 12 files changed, 56 insertions(+), 13 deletions(-) create mode 100644 packages/chat-core/docs/chat-core.integrationdetails.zendeskhandoff.md create mode 100644 packages/chat-core/docs/chat-core.zendeskhandoff.md create mode 100644 packages/chat-core/src/models/integrations/Zendesk.ts diff --git a/package-lock.json b/package-lock.json index 222691a..605873f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9242,7 +9242,7 @@ }, "packages/chat-core": { "name": "@yext/chat-core", - "version": "0.9.0", + "version": "0.9.1", "license": "BSD-3-Clause", "dependencies": { "cross-fetch": "^3.1.5" diff --git a/packages/chat-core-aws-connect/THIRD-PARTY-NOTICES b/packages/chat-core-aws-connect/THIRD-PARTY-NOTICES index 2cfd54f..99aa230 100644 --- a/packages/chat-core-aws-connect/THIRD-PARTY-NOTICES +++ b/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 diff --git a/packages/chat-core/docs/chat-core.integrationdetails.md b/packages/chat-core/docs/chat-core.integrationdetails.md index ff6e430..8cf2947 100644 --- a/packages/chat-core/docs/chat-core.integrationdetails.md +++ b/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. | diff --git a/packages/chat-core/docs/chat-core.integrationdetails.zendeskhandoff.md b/packages/chat-core/docs/chat-core.integrationdetails.zendeskhandoff.md new file mode 100644 index 0000000..bffe5fe --- /dev/null +++ b/packages/chat-core/docs/chat-core.integrationdetails.zendeskhandoff.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/chat-core](./chat-core.md) > [IntegrationDetails](./chat-core.integrationdetails.md) > [zendeskHandoff](./chat-core.integrationdetails.zendeskhandoff.md) + +## IntegrationDetails.zendeskHandoff property + +Configurations for Zendesk handoff. + +**Signature:** + +```typescript +zendeskHandoff?: ZendeskHandoff; +``` diff --git a/packages/chat-core/docs/chat-core.md b/packages/chat-core/docs/chat-core.md index 7371156..884c8da 100644 --- a/packages/chat-core/docs/chat-core.md +++ b/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 diff --git a/packages/chat-core/docs/chat-core.zendeskhandoff.md b/packages/chat-core/docs/chat-core.zendeskhandoff.md new file mode 100644 index 0000000..1085831 --- /dev/null +++ b/packages/chat-core/docs/chat-core.zendeskhandoff.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/chat-core](./chat-core.md) > [ZendeskHandoff](./chat-core.zendeskhandoff.md) + +## ZendeskHandoff interface + +Configurations for Zendesk handoff. + +**Signature:** + +```typescript +export interface ZendeskHandoff +``` diff --git a/packages/chat-core/etc/chat-core.api.md b/packages/chat-core/etc/chat-core.api.md index aeba2f7..cd81125 100644 --- a/packages/chat-core/etc/chat-core.api.md +++ b/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; } +// @public +export interface ZendeskHandoff { +} + // (No @packageDocumentation comment for this package) ``` diff --git a/packages/chat-core/package.json b/packages/chat-core/package.json index 01c3a71..3baa3e9 100644 --- a/packages/chat-core/package.json +++ b/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", diff --git a/packages/chat-core/src/models/index.ts b/packages/chat-core/src/models/index.ts index 0821325..19bc9ed 100644 --- a/packages/chat-core/src/models/index.ts +++ b/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"; diff --git a/packages/chat-core/src/models/integrations/IntegrationDetails.ts b/packages/chat-core/src/models/integrations/IntegrationDetails.ts index 28712c6..012eacf 100644 --- a/packages/chat-core/src/models/integrations/IntegrationDetails.ts +++ b/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; } diff --git a/packages/chat-core/src/models/integrations/Zendesk.ts b/packages/chat-core/src/models/integrations/Zendesk.ts new file mode 100644 index 0000000..32cf9c3 --- /dev/null +++ b/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 {} diff --git a/test-sites/test-browser-esm/package-lock.json b/test-sites/test-browser-esm/package-lock.json index 265e312..dde5088 100644 --- a/test-sites/test-browser-esm/package-lock.json +++ b/test-sites/test-browser-esm/package-lock.json @@ -49,7 +49,7 @@ }, "../../packages/chat-core": { "name": "@yext/chat-core", - "version": "0.8.2", + "version": "0.9.1", "license": "BSD-3-Clause", "dependencies": { "cross-fetch": "^3.1.5" @@ -74,11 +74,11 @@ } }, "../../packages/chat-core-aws-connect": { + "name": "@yext/chat-core-aws-connect", "version": "0.1.0", "license": "BSD-3-Clause", "dependencies": { - "amazon-connect-chatjs": "^2.3.0", - "cross-fetch": "^3.1.5" + "amazon-connect-chatjs": "^2.3.0" }, "devDependencies": { "@babel/preset-env": "^7.21.5",