genesys-cloud-streaming-client 14.2.1-PCM-1963.1 → 14.2.1-develop.21

package/dist/cjs/types/interfaces.d.ts

@@ -118,3 +118,8 @@ export interface IPendingSession {
     accepted?: boolean;
     sessionType: SessionTypes | SessionTypesAsStrings;
 }
+export interface JsonRpcMessage {
+    jsonrpc: string;
+    method: string;
+    params?: any;
+}

package/dist/cjs/types/media-session.d.ts

@@ -6,7 +6,7 @@ import StrictEventEmitter from 'strict-event-emitter-types';
 import { EventEmitter } from 'events';
 import { JingleReason, JingleInfo, Jingle } from 'stanza/protocol';
 import { ActionCallback, SessionOpts } from 'stanza/jingle/Session';
-import { SessionTypes, SessionTypesAsStrings } from './interfaces';
+import { JsonRpcMessage, SessionTypes, SessionTypesAsStrings } from './interfaces';
 export interface IGenesysCloudMediaSessionParams {
     options: SessionOpts;
     sessionType: SessionTypes | SessionTypesAsStrings;
@@ -30,6 +30,7 @@ export declare class GenesysCloudMediaSession extends MediaSession {
     ignoreHostCandidatesFromRemote: boolean;
     allowIPv6: boolean;
     allowTCP: boolean;
+    dataChannel?: RTCDataChannel;
     constructor(params: IGenesysCloudMediaSessionParams);
     private getLogDetails;
     onTransportInfo(changes: Jingle, cb: ActionCallback): Promise<void>;
@@ -42,6 +43,8 @@ export declare class GenesysCloudMediaSession extends MediaSession {
     onIceCandidate(e: RTCPeerConnectionIceEvent): void;
     onIceEndOfCandidates(): void;
     addTrack(track: MediaStreamTrack, stream?: MediaStream): Promise<void>;
+    _setupDataChannel(): void;
+    _handleDataChannelMessage(event: MessageEvent): void;
 }
 export interface SessionEvents {
     iceConnectionType: ({
@@ -58,6 +61,7 @@ export interface SessionEvents {
     terminated: JingleReason;
     stats: StatsEvent;
     endOfCandidates: void;
+    dataChannelMessage: JsonRpcMessage;
 }
 export interface GenesysCloudMediaSession extends StrictEventEmitter<EventEmitter, SessionEvents> {
 }

package/dist/cjs/types/media-session.js

@@ -119,6 +119,7 @@ class GenesysCloudMediaSession extends jingle_1.MediaSession {
                     infoType: Constants_1.JINGLE_INFO_ACTIVE
                 }
             });
+            this._setupDataChannel();
         }
         else if (iceState === 'failed') {
             this._log('info', 'ICE connection failed', {
@@ -185,5 +186,37 @@ class GenesysCloudMediaSession extends jingle_1.MediaSession {
             return;
         });
     }
+    _setupDataChannel() {
+        var _a;
+        // this shouldn't happen, but we shouldn't set the datachannel up more than once
+        if (this.dataChannel) {
+            return;
+        }
+        // do nothing if a datachannel wasn't offered
+        if ((_a = this.pc.localDescription) === null || _a === void 0 ? void 0 : _a.sdp.includes('webrtc-datachannel')) {
+            this._log('info', 'creating data channel');
+            this.dataChannel = this.pc.createDataChannel('videoConferenceControl');
+            this.dataChannel.addEventListener('open', () => {
+                this._log('info', 'data channel opened');
+            });
+            this.dataChannel.addEventListener('message', this._handleDataChannelMessage.bind(this));
+            this.dataChannel.addEventListener('close', () => {
+                this._log('info', 'closing data channel');
+            });
+            this.dataChannel.addEventListener('error', (error) => {
+                this._log('error', 'Error occurred with the data channel', error);
+            });
+        }
+    }
+    _handleDataChannelMessage(event) {
+        this._log('debug', 'data channel message received', event);
+        try {
+            const message = JSON.parse(event.data);
+            this.emit('dataChannelMessage', message);
+        }
+        catch (e) {
+            this._log('error', 'Failed to parse data channel message', { error: e });
+        }
+    }
 }
 exports.GenesysCloudMediaSession = GenesysCloudMediaSession;

package/dist/deploy-info.json

@@ -1,6 +1,6 @@
 {
   "name": "developercenter-cdn/streaming-client",
-  "version": "PCM-1963",
+  "version": "14.2.1",
   "ecosystem": "pc",
   "team": "Genesys Client Media (WebRTC)",
   "indexFiles": [
@@ -17,6 +17,6 @@
       "file": "/v14/streaming-client.browser.js"
     }
   ],
-  "build": "1",
-  "buildDate": "2022-09-13T21:42:33.695073Z"
+  "build": "21",
+  "buildDate": "2022-09-14T21:29:01.144206Z"
 }

package/dist/es/index.bundle.js

@@ -41472,6 +41472,7 @@ class GenesysCloudMediaSession extends jingle.MediaSession {
                     infoType: Constants.JINGLE_INFO_ACTIVE
                 }
             });
+            this._setupDataChannel();
         }
         else if (iceState === 'failed') {
             this._log('info', 'ICE connection failed', {
@@ -41538,6 +41539,38 @@ class GenesysCloudMediaSession extends jingle.MediaSession {
             return;
         }));
     }
+    _setupDataChannel() {
+        var _a;
+        // this shouldn't happen, but we shouldn't set the datachannel up more than once
+        if (this.dataChannel) {
+            return;
+        }
+        // do nothing if a datachannel wasn't offered
+        if ((_a = this.pc.localDescription) === null || _a === void 0 ? void 0 : _a.sdp.includes('webrtc-datachannel')) {
+            this._log('info', 'creating data channel');
+            this.dataChannel = this.pc.createDataChannel('videoConferenceControl');
+            this.dataChannel.addEventListener('open', () => {
+                this._log('info', 'data channel opened');
+            });
+            this.dataChannel.addEventListener('message', this._handleDataChannelMessage.bind(this));
+            this.dataChannel.addEventListener('close', () => {
+                this._log('info', 'closing data channel');
+            });
+            this.dataChannel.addEventListener('error', (error) => {
+                this._log('error', 'Error occurred with the data channel', error);
+            });
+        }
+    }
+    _handleDataChannelMessage(event) {
+        this._log('debug', 'data channel message received', event);
+        try {
+            const message = JSON.parse(event.data);
+            this.emit('dataChannelMessage', message);
+        }
+        catch (e) {
+            this._log('error', 'Failed to parse data channel message', { error: e });
+        }
+    }
 }
 
 function formatStatsEvent(event, extraDetails = {}) {

package/dist/es/types/interfaces.d.ts

@@ -118,3 +118,8 @@ export interface IPendingSession {
     accepted?: boolean;
     sessionType: SessionTypes | SessionTypesAsStrings;
 }
+export interface JsonRpcMessage {
+    jsonrpc: string;
+    method: string;
+    params?: any;
+}

package/dist/es/types/media-session.d.ts

@@ -6,7 +6,7 @@ import StrictEventEmitter from 'strict-event-emitter-types';
 import { EventEmitter } from 'events';
 import { JingleReason, JingleInfo, Jingle } from 'stanza/protocol';
 import { ActionCallback, SessionOpts } from 'stanza/jingle/Session';
-import { SessionTypes, SessionTypesAsStrings } from './interfaces';
+import { JsonRpcMessage, SessionTypes, SessionTypesAsStrings } from './interfaces';
 export interface IGenesysCloudMediaSessionParams {
     options: SessionOpts;
     sessionType: SessionTypes | SessionTypesAsStrings;
@@ -30,6 +30,7 @@ export declare class GenesysCloudMediaSession extends MediaSession {
     ignoreHostCandidatesFromRemote: boolean;
     allowIPv6: boolean;
     allowTCP: boolean;
+    dataChannel?: RTCDataChannel;
     constructor(params: IGenesysCloudMediaSessionParams);
     private getLogDetails;
     onTransportInfo(changes: Jingle, cb: ActionCallback): Promise<void>;
@@ -42,6 +43,8 @@ export declare class GenesysCloudMediaSession extends MediaSession {
     onIceCandidate(e: RTCPeerConnectionIceEvent): void;
     onIceEndOfCandidates(): void;
     addTrack(track: MediaStreamTrack, stream?: MediaStream): Promise<void>;
+    _setupDataChannel(): void;
+    _handleDataChannelMessage(event: MessageEvent): void;
 }
 export interface SessionEvents {
     iceConnectionType: ({
@@ -58,6 +61,7 @@ export interface SessionEvents {
     terminated: JingleReason;
     stats: StatsEvent;
     endOfCandidates: void;
+    dataChannelMessage: JsonRpcMessage;
 }
 export interface GenesysCloudMediaSession extends StrictEventEmitter<EventEmitter, SessionEvents> {
 }

package/dist/es/types/media-session.js

@@ -121,6 +121,7 @@ export class GenesysCloudMediaSession extends MediaSession {
                     infoType: JINGLE_INFO_ACTIVE
                 }
             });
+            this._setupDataChannel();
         }
         else if (iceState === 'failed') {
             this._log('info', 'ICE connection failed', {
@@ -187,4 +188,36 @@ export class GenesysCloudMediaSession extends MediaSession {
             return;
         }));
     }
+    _setupDataChannel() {
+        var _a;
+        // this shouldn't happen, but we shouldn't set the datachannel up more than once
+        if (this.dataChannel) {
+            return;
+        }
+        // do nothing if a datachannel wasn't offered
+        if ((_a = this.pc.localDescription) === null || _a === void 0 ? void 0 : _a.sdp.includes('webrtc-datachannel')) {
+            this._log('info', 'creating data channel');
+            this.dataChannel = this.pc.createDataChannel('videoConferenceControl');
+            this.dataChannel.addEventListener('open', () => {
+                this._log('info', 'data channel opened');
+            });
+            this.dataChannel.addEventListener('message', this._handleDataChannelMessage.bind(this));
+            this.dataChannel.addEventListener('close', () => {
+                this._log('info', 'closing data channel');
+            });
+            this.dataChannel.addEventListener('error', (error) => {
+                this._log('error', 'Error occurred with the data channel', error);
+            });
+        }
+    }
+    _handleDataChannelMessage(event) {
+        this._log('debug', 'data channel message received', event);
+        try {
+            const message = JSON.parse(event.data);
+            this.emit('dataChannelMessage', message);
+        }
+        catch (e) {
+            this._log('error', 'Failed to parse data channel message', { error: e });
+        }
+    }
 }

package/dist/npm/CHANGELOG.md

@@ -4,9 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 # [Unreleased](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v14.2.0...HEAD)
+
+### Added
+* [PCM-1972](https://inindca.atlassian.net/browse/PCM-1972) – Added support for data channel messages if initially offered in the sdp
+
 ### Fixed
 * [PCM-1963](https://inindca.atlassian.net/browse/PCM-1963) - Added missing error text from switch to Axios from SuperAgent.
 
+
 # [v14.2.0](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v14.1.2...v14.2.0)
 ### Added
 * [PCM-1944](https://inindca.atlassian.net/browse/PCM-1944) – Added reconnect options to the `streamingClient.connect` so it will continue to try to connect at a given interval. This is separate from the reconnection logic in the case where the client connected but disconnected unexpectedly.

package/dist/npm/types/interfaces.d.ts

@@ -118,3 +118,8 @@ export interface IPendingSession {
     accepted?: boolean;
     sessionType: SessionTypes | SessionTypesAsStrings;
 }
+export interface JsonRpcMessage {
+    jsonrpc: string;
+    method: string;
+    params?: any;
+}

package/dist/npm/types/media-session.d.ts

@@ -6,7 +6,7 @@ import StrictEventEmitter from 'strict-event-emitter-types';
 import { EventEmitter } from 'events';
 import { JingleReason, JingleInfo, Jingle } from 'stanza/protocol';
 import { ActionCallback, SessionOpts } from 'stanza/jingle/Session';
-import { SessionTypes, SessionTypesAsStrings } from './interfaces';
+import { JsonRpcMessage, SessionTypes, SessionTypesAsStrings } from './interfaces';
 export interface IGenesysCloudMediaSessionParams {
     options: SessionOpts;
     sessionType: SessionTypes | SessionTypesAsStrings;
@@ -30,6 +30,7 @@ export declare class GenesysCloudMediaSession extends MediaSession {
     ignoreHostCandidatesFromRemote: boolean;
     allowIPv6: boolean;
     allowTCP: boolean;
+    dataChannel?: RTCDataChannel;
     constructor(params: IGenesysCloudMediaSessionParams);
     private getLogDetails;
     onTransportInfo(changes: Jingle, cb: ActionCallback): Promise<void>;
@@ -42,6 +43,8 @@ export declare class GenesysCloudMediaSession extends MediaSession {
     onIceCandidate(e: RTCPeerConnectionIceEvent): void;
     onIceEndOfCandidates(): void;
     addTrack(track: MediaStreamTrack, stream?: MediaStream): Promise<void>;
+    _setupDataChannel(): void;
+    _handleDataChannelMessage(event: MessageEvent): void;
 }
 export interface SessionEvents {
     iceConnectionType: ({
@@ -58,6 +61,7 @@ export interface SessionEvents {
     terminated: JingleReason;
     stats: StatsEvent;
     endOfCandidates: void;
+    dataChannelMessage: JsonRpcMessage;
 }
 export interface GenesysCloudMediaSession extends StrictEventEmitter<EventEmitter, SessionEvents> {
 }

package/dist/npm/types/media-session.js

@@ -119,6 +119,7 @@ class GenesysCloudMediaSession extends jingle_1.MediaSession {
                     infoType: Constants_1.JINGLE_INFO_ACTIVE
                 }
             });
+            this._setupDataChannel();
         }
         else if (iceState === 'failed') {
             this._log('info', 'ICE connection failed', {
@@ -185,5 +186,37 @@ class GenesysCloudMediaSession extends jingle_1.MediaSession {
             return;
         });
     }
+    _setupDataChannel() {
+        var _a;
+        // this shouldn't happen, but we shouldn't set the datachannel up more than once
+        if (this.dataChannel) {
+            return;
+        }
+        // do nothing if a datachannel wasn't offered
+        if ((_a = this.pc.localDescription) === null || _a === void 0 ? void 0 : _a.sdp.includes('webrtc-datachannel')) {
+            this._log('info', 'creating data channel');
+            this.dataChannel = this.pc.createDataChannel('videoConferenceControl');
+            this.dataChannel.addEventListener('open', () => {
+                this._log('info', 'data channel opened');
+            });
+            this.dataChannel.addEventListener('message', this._handleDataChannelMessage.bind(this));
+            this.dataChannel.addEventListener('close', () => {
+                this._log('info', 'closing data channel');
+            });
+            this.dataChannel.addEventListener('error', (error) => {
+                this._log('error', 'Error occurred with the data channel', error);
+            });
+        }
+    }
+    _handleDataChannelMessage(event) {
+        this._log('debug', 'data channel message received', event);
+        try {
+            const message = JSON.parse(event.data);
+            this.emit('dataChannelMessage', message);
+        }
+        catch (e) {
+            this._log('error', 'Failed to parse data channel message', { error: e });
+        }
+    }
 }
 exports.GenesysCloudMediaSession = GenesysCloudMediaSession;