amazon-connect-chatjs - npm Package Compare versions

Comparing version 2.0.2 to 2.1.0

CHANGELOG.md

@@ -7,2 +7,6 @@ # Changelog
 
+## [2.1.0]
+### Added
+- The [DescribeView API](https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_DescribeView.html)
+
 ## [2.0.2]
@@ -9,0 +13,0 @@ ### Added

dist/client/client.d.ts

@@ -24,2 +24,3 @@ export var ChatClientFactory: ChatClientFactoryImpl;
     };
+    describeView(viewToken: any, connectionToken: any): Promise<any>;
     createParticipantConnection(participantToken: any, type: any, acknowledgeConnection: any): Promise<any>;
@@ -45,3 +46,4 @@ disconnectParticipant(connectionToken: any): Promise<any>;
     createParticipantConnection(participantToken: any, type: any): void;
+    describeView(): void;
 }
 export {};

dist/constants.d.ts

@@ -34,2 +34,3 @@ export namespace CHAT_CONFIGURATIONS {
     const CREATE_PARTICIPANT_CONNECTION: string;
+    const DESCRIBE_VIEW: string;
 }
@@ -36,0 +37,0 @@ export namespace WEBSOCKET_EVENTS {

dist/core/chatController.d.ts

@@ -72,2 +72,3 @@ export function getEventTypeFromContentType(contentType: any): string;
     };
+    describeView(args: any): any;
     _convertConnectionHelperStatus(connectionHelperStatus: any): string | undefined;
@@ -74,0 +75,0 @@ getConnectionStatus(): string | undefined;

dist/core/chatSession.d.ts

@@ -22,2 +22,3 @@ export class ChatSession {
     getChatDetails(): any;
+    describeView(args: any): any;
 }
@@ -24,0 +25,0 @@ export const CHAT_SESSION_FACTORY: PersistentConnectionAndChatServiceSessionFactory;

dist/index.d.ts

@@ -23,2 +23,3 @@ export const ChatSession: {
         getChatDetails(): any;
+        describeView(args: any): any;
     } | {
@@ -45,2 +46,3 @@ disconnectParticipant(): any;
         getChatDetails(): any;
+        describeView(args: any): any;
     };
@@ -47,0 +49,0 @@ setGlobalConfig: (config: any) => void;

package.json

 {
   "name": "amazon-connect-chatjs",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "main": "dist/amazon-connect-chat.js",
@@ -5,0 +5,0 @@ "types": "dist/index.d.ts",

README.md

@@ -715,2 +715,20 @@ # Amazon Connect ChatJS [![npm](https://img.shields.io/npm/v/amazon-connect-chatjs.svg?color=orange)](https://www.npmjs.com/package/amazon-connect-chatjs) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Node.js CI](https://github.com/amazon-connect/amazon-connect-chatjs/actions/workflows/node.js.yml/badge.svg?branch=master)](https://github.com/amazon-connect/amazon-connect-chatjs/actions/workflows/node.js.yml)
 
+##### `chatSession.describeView()`
+```js
+const {
+  View
+} = chatSession.describeView({
+  viewToken: "QVFJREFIaGIyaHZJWUZzNlVmMGVIY2NXdUVMMzdBTnprOGZkc3huRzhkSXR6eExOeXdGYTFwYitiOGRybklmMEZHbjBGZU1sQUFBQWJqQnNCZ2txaGtpRzl3MEJCd2FnWHpCZEFnRUFNRmdHQ1NxR1NJYjNEUUVIQVRBZUJnbGdoa2dCWlFNRUFTNHdFUVFNKys3ei9KTU41dG1BMWF4UkFnRVFnQ3NLckhKTEdXMUsyR1kvVHBUWWp0SmZxSG83VlcvOTg5WGZvckpMWDhOcGVJVHcrWUtnWjVwN3NxNGk6OlJ6STltam5rZjBiNENhOVdzM0wwaWxjR1dWUUxnb1Y1dmxNaEE5aGRkemZuV09hY0JEZFlpWFhpWnRPQlowNW9HT28xb0VnZ3JWV21aeWN0anhZZi9lOUdrYklSZVR5N2tpQmRRelFXSGpXZHpFSUExRCtvcWl5VGMzMzJoaWRldU5IaWwreEkvNmNmWUtpMXd5Qnh1aG0yY1AyWmk2byt2bTRDalFhWGxaM0Zrb1dqLy91aDVvRmtZcDY4UERuU0ZVQ1AyUU0zcjhNazI1ckZ2M0p6Z210bnMrSzVYY2VPN0xqWE1JMHZ0RE5uVEVYR1ZDcnc3SE82R0JITjV4NWporWGM9\\\", //REQUIRED
+  metadata: "foo" //OPTIONAL
+}).data;
+```
+ Wraps the [DescribeView](https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_DescribeView.html) API.
+ 
+The arguments are based on the [API model](https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_DescribeView.html) with the following differences:
+ 
+- All fields are in camelCase. 
+ 
+ChatJS automatically supplies the connectionToken via the session's internal data. 
+This api will only function after `chatSession.connect()` succeeds.
+
 ##### `agentChatSession.cleanUpOnParticipantDisconnect()`
@@ -717,0 +735,0 @@

No alert changes

Improved metrics

Total package byte prevSize

1421329

increased by5.66%

Lines of code

2631

increased by3.87%

Number of lines in readme file

939

increased by1.95%

No dependency changes