genesys-cloud-streaming-client 14.0.1-develop.9 → 14.1.0

package/dist/cjs/client.d.ts

@@ -21,6 +21,8 @@ export declare class Client {
     deadChannels: string[];
     config: IClientConfig;
     streamId: any;
+    backgroundAssistantMode: boolean;
+    isGuest: boolean;
     http: HttpClient;
     notifications: NotificationsAPI;
     _notifications: Notifications;
@@ -30,6 +32,7 @@ export declare class Client {
     _ping: Ping;
     _reconnector: Reconnector;
     constructor(options: IClientOptions);
+    private checkIsBackgroundAssistant;
     cleanupLeakTimer(): void;
     on(eventName: any, ...args: any[]): this;
     once(eventName: any, ...args: any[]): this;
@@ -42,5 +45,6 @@ export declare class Client {
     startServerLogging(): void;
     setAccessToken(token: string): void;
     static extend(namespace: any, extension: StreamingClientExtension | ((client: Client) => void)): void;
+    get version(): string;
     static get version(): string;
 }

package/dist/cjs/client.js

@@ -64,6 +64,8 @@ class Client {
         this.hardReconnectCount = 0;
         this.reconnectLeakTime = 1000 * 60 * 10; // 10 minutes
         this.deadChannels = [];
+        this.backgroundAssistantMode = false;
+        this.isGuest = false;
         this.http = new http_client_1.HttpClient();
         const stanzaio = stanza_1.createClient({});
         // TODO: remove this hack when we can. basically stanza messes up the auth mechanism priority.
@@ -82,12 +84,19 @@ class Client {
             appName: options.appName,
             appVersion: options.appVersion
         };
-        const accessToken = options.authToken || '';
+        this.backgroundAssistantMode = this.checkIsBackgroundAssistant();
+        this.isGuest = !this.backgroundAssistantMode && !options.authToken;
+        let loggerAccessToken = options.authToken || '';
+        let loggerUrl = `https://api.${this.config.apiHost}/api/v2/diagnostics/trace`;
+        if (this.backgroundAssistantMode) {
+            loggerAccessToken = options.jwt;
+            loggerUrl += '/backgroundassistant';
+        }
         this.logger = new genesys_cloud_client_logger_1.Logger({
-            accessToken,
-            url: `https://api.${this.config.apiHost}/api/v2/diagnostics/trace`,
+            accessToken: loggerAccessToken,
+            url: loggerUrl,
             uploadDebounceTime: 1000,
-            initializeServerLogging: !options.optOutOfWebrtcStatsTelemetry,
+            initializeServerLogging: !this.isGuest && !options.optOutOfWebrtcStatsTelemetry,
             /* streaming-client logging info */
             appVersion: Client.version,
             appName: 'streaming-client',
@@ -204,6 +213,13 @@ class Client {
             this[`_${extensionName}`] = extension;
         });
     }
+    checkIsBackgroundAssistant() {
+        if (this.config.jwt) {
+            const jwt = utils_1.parseJwt(this.config.jwt);
+            return jwt && jwt.iss === 'urn:purecloud:screenrecording';
+        }
+        return false;
+    }
     cleanupLeakTimer() {
         clearInterval(this.leakyReconnectTimer);
         this.leakyReconnectTimer = null;
@@ -349,8 +365,11 @@ class Client {
         }
         extensions[namespace] = extension;
     }
+    get version() {
+        return Client.version;
+    }
     static get version() {
-        return '14.0.1';
+        return '14.1.0';
     }
 }
 exports.Client = Client;

package/dist/cjs/http-client.js

@@ -23,10 +23,9 @@ class HttpClient {
         const params = {
             method: opts.method,
             url,
+            data: opts.data,
             headers: {
-                'content-type': opts.contentType || 'application/json',
-                // we may not need this
-                'accept-encoding': 'gzip, deflate'
+                'content-type': opts.contentType || 'application/json'
             }
         };
         // default to include auth header

package/dist/cjs/webrtc.js

@@ -157,7 +157,7 @@ class WebrtcExtension extends events_1.EventEmitter {
         }
         this.statsArr.splice(0, statsToSend.length);
         this.statBuffer = this.statsArr.reduce((currentSize, stats) => currentSize + utils_1.calculatePayloadSize(stats), 0);
-        if (!statsToSend.length || !this.client.config.authToken) {
+        if (!statsToSend.length || this.client.isGuest) {
             return;
         }
         const data = {
@@ -169,10 +169,16 @@ class WebrtcExtension extends events_1.EventEmitter {
         };
         // At least for now, we'll just fire and forget. Since this is non-critical, we'll not retry failures
         try {
-            await this.client.http.requestApi('diagnostics/newrelic/insights', {
+            let authToken = this.client.config.authToken;
+            let url = 'diagnostics/newrelic/insights';
+            if (this.client.backgroundAssistantMode) {
+                authToken = this.client.config.jwt;
+                url += '/backgroundassistant';
+            }
+            await this.client.http.requestApi(url, {
                 method: 'post',
                 host: this.client.config.apiHost,
-                authToken: this.client.config.authToken,
+                authToken,
                 logger: this.client.logger,
                 data
             });

package/dist/deploy-info.json

@@ -1,14 +1,14 @@
 {
   "name": "developercenter-cdn/streaming-client",
-  "version": "develop",
+  "version": "14.1.0",
   "ecosystem": "pc",
   "team": "Genesys Client Media (WebRTC)",
   "indexFiles": [
     {
-      "file": "/v14.0.1/streaming-client.browser.ie.js"
+      "file": "/v14.1.0/streaming-client.browser.ie.js"
     },
     {
-      "file": "/v14.0.1/streaming-client.browser.js"
+      "file": "/v14.1.0/streaming-client.browser.js"
     },
     {
       "file": "/v14/streaming-client.browser.ie.js"
@@ -17,6 +17,6 @@
       "file": "/v14/streaming-client.browser.js"
     }
   ],
-  "build": "9",
-  "buildDate": "2022-06-01T15:49:16.445265Z"
+  "build": "34",
+  "buildDate": "2022-06-08T13:55:21.778993Z"
 }

package/dist/es/client.d.ts

@@ -21,6 +21,8 @@ export declare class Client {
     deadChannels: string[];
     config: IClientConfig;
     streamId: any;
+    backgroundAssistantMode: boolean;
+    isGuest: boolean;
     http: HttpClient;
     notifications: NotificationsAPI;
     _notifications: Notifications;
@@ -30,6 +32,7 @@ export declare class Client {
     _ping: Ping;
     _reconnector: Reconnector;
     constructor(options: IClientOptions);
+    private checkIsBackgroundAssistant;
     cleanupLeakTimer(): void;
     on(eventName: any, ...args: any[]): this;
     once(eventName: any, ...args: any[]): this;
@@ -42,5 +45,6 @@ export declare class Client {
     startServerLogging(): void;
     setAccessToken(token: string): void;
     static extend(namespace: any, extension: StreamingClientExtension | ((client: Client) => void)): void;
+    get version(): string;
     static get version(): string;
 }

package/dist/es/client.js

@@ -63,6 +63,8 @@ export class Client {
         this.hardReconnectCount = 0;
         this.reconnectLeakTime = 1000 * 60 * 10; // 10 minutes
         this.deadChannels = [];
+        this.backgroundAssistantMode = false;
+        this.isGuest = false;
         this.http = new HttpClient();
         const stanzaio = createStanzaClient({});
         // TODO: remove this hack when we can. basically stanza messes up the auth mechanism priority.
@@ -81,12 +83,19 @@ export class Client {
             appName: options.appName,
             appVersion: options.appVersion
         };
-        const accessToken = options.authToken || '';
+        this.backgroundAssistantMode = this.checkIsBackgroundAssistant();
+        this.isGuest = !this.backgroundAssistantMode && !options.authToken;
+        let loggerAccessToken = options.authToken || '';
+        let loggerUrl = `https://api.${this.config.apiHost}/api/v2/diagnostics/trace`;
+        if (this.backgroundAssistantMode) {
+            loggerAccessToken = options.jwt;
+            loggerUrl += '/backgroundassistant';
+        }
         this.logger = new Logger({
-            accessToken,
-            url: `https://api.${this.config.apiHost}/api/v2/diagnostics/trace`,
+            accessToken: loggerAccessToken,
+            url: loggerUrl,
             uploadDebounceTime: 1000,
-            initializeServerLogging: !options.optOutOfWebrtcStatsTelemetry,
+            initializeServerLogging: !this.isGuest && !options.optOutOfWebrtcStatsTelemetry,
             /* streaming-client logging info */
             appVersion: Client.version,
             appName: 'streaming-client',
@@ -203,6 +212,13 @@ export class Client {
             this[`_${extensionName}`] = extension;
         });
     }
+    checkIsBackgroundAssistant() {
+        if (this.config.jwt) {
+            const jwt = parseJwt(this.config.jwt);
+            return jwt && jwt.iss === 'urn:purecloud:screenrecording';
+        }
+        return false;
+    }
     cleanupLeakTimer() {
         clearInterval(this.leakyReconnectTimer);
         this.leakyReconnectTimer = null;
@@ -350,7 +366,10 @@ export class Client {
         }
         extensions[namespace] = extension;
     }
+    get version() {
+        return Client.version;
+    }
     static get version() {
-        return '14.0.1';
+        return '14.1.0';
     }
 }

package/dist/es/http-client.js

@@ -19,10 +19,9 @@ export class HttpClient {
         const params = {
             method: opts.method,
             url,
+            data: opts.data,
             headers: {
-                'content-type': opts.contentType || 'application/json',
-                // we may not need this
-                'accept-encoding': 'gzip, deflate'
+                'content-type': opts.contentType || 'application/json'
             }
         };
         // default to include auth header

package/dist/es/index.bundle.js

@@ -41946,7 +41946,7 @@ class WebrtcExtension extends EventEmitter {
             }
             this.statsArr.splice(0, statsToSend.length);
             this.statBuffer = this.statsArr.reduce((currentSize, stats) => currentSize + calculatePayloadSize(stats), 0);
-            if (!statsToSend.length || !this.client.config.authToken) {
+            if (!statsToSend.length || this.client.isGuest) {
                 return;
             }
             const data = {
@@ -41958,10 +41958,16 @@ class WebrtcExtension extends EventEmitter {
             };
             // At least for now, we'll just fire and forget. Since this is non-critical, we'll not retry failures
             try {
-                yield this.client.http.requestApi('diagnostics/newrelic/insights', {
+                let authToken = this.client.config.authToken;
+                let url = 'diagnostics/newrelic/insights';
+                if (this.client.backgroundAssistantMode) {
+                    authToken = this.client.config.jwt;
+                    url += '/backgroundassistant';
+                }
+                yield this.client.http.requestApi(url, {
                     method: 'post',
                     host: this.client.config.apiHost,
-                    authToken: this.client.config.authToken,
+                    authToken,
                     logger: this.client.logger,
                     data
                 });
@@ -42836,10 +42842,9 @@ class HttpClient {
         const params = {
             method: opts.method,
             url,
+            data: opts.data,
             headers: {
-                'content-type': opts.contentType || 'application/json',
-                // we may not need this
-                'accept-encoding': 'gzip, deflate'
+                'content-type': opts.contentType || 'application/json'
             }
         };
         // default to include auth header
@@ -43244,6 +43249,8 @@ class Client {
         this.hardReconnectCount = 0;
         this.reconnectLeakTime = 1000 * 60 * 10; // 10 minutes
         this.deadChannels = [];
+        this.backgroundAssistantMode = false;
+        this.isGuest = false;
         this.http = new HttpClient();
         const stanzaio = createClient({});
         // TODO: remove this hack when we can. basically stanza messes up the auth mechanism priority.
@@ -43262,12 +43269,19 @@ class Client {
             appName: options.appName,
             appVersion: options.appVersion
         };
-        const accessToken = options.authToken || '';
+        this.backgroundAssistantMode = this.checkIsBackgroundAssistant();
+        this.isGuest = !this.backgroundAssistantMode && !options.authToken;
+        let loggerAccessToken = options.authToken || '';
+        let loggerUrl = `https://api.${this.config.apiHost}/api/v2/diagnostics/trace`;
+        if (this.backgroundAssistantMode) {
+            loggerAccessToken = options.jwt;
+            loggerUrl += '/backgroundassistant';
+        }
         this.logger = new Logger({
-            accessToken,
-            url: `https://api.${this.config.apiHost}/api/v2/diagnostics/trace`,
+            accessToken: loggerAccessToken,
+            url: loggerUrl,
             uploadDebounceTime: 1000,
-            initializeServerLogging: !options.optOutOfWebrtcStatsTelemetry,
+            initializeServerLogging: !this.isGuest && !options.optOutOfWebrtcStatsTelemetry,
             /* streaming-client logging info */
             appVersion: Client.version,
             appName: 'streaming-client',
@@ -43384,6 +43398,13 @@ class Client {
             this[`_${extensionName}`] = extension;
         });
     }
+    checkIsBackgroundAssistant() {
+        if (this.config.jwt) {
+            const jwt = parseJwt(this.config.jwt);
+            return jwt && jwt.iss === 'urn:purecloud:screenrecording';
+        }
+        return false;
+    }
     cleanupLeakTimer() {
         clearInterval(this.leakyReconnectTimer);
         this.leakyReconnectTimer = null;
@@ -43531,8 +43552,11 @@ class Client {
         }
         extensions[namespace] = extension;
     }
+    get version() {
+        return Client.version;
+    }
     static get version() {
-        return '14.0.1';
+        return '14.1.0';
     }
 }
 

package/dist/es/webrtc.js

@@ -155,7 +155,7 @@ export class WebrtcExtension extends EventEmitter {
             }
             this.statsArr.splice(0, statsToSend.length);
             this.statBuffer = this.statsArr.reduce((currentSize, stats) => currentSize + calculatePayloadSize(stats), 0);
-            if (!statsToSend.length || !this.client.config.authToken) {
+            if (!statsToSend.length || this.client.isGuest) {
                 return;
             }
             const data = {
@@ -167,10 +167,16 @@ export class WebrtcExtension extends EventEmitter {
             };
             // At least for now, we'll just fire and forget. Since this is non-critical, we'll not retry failures
             try {
-                yield this.client.http.requestApi('diagnostics/newrelic/insights', {
+                let authToken = this.client.config.authToken;
+                let url = 'diagnostics/newrelic/insights';
+                if (this.client.backgroundAssistantMode) {
+                    authToken = this.client.config.jwt;
+                    url += '/backgroundassistant';
+                }
+                yield this.client.http.requestApi(url, {
                     method: 'post',
                     host: this.client.config.apiHost,
-                    authToken: this.client.config.authToken,
+                    authToken,
                     logger: this.client.logger,
                     data
                 });

package/dist/npm/CHANGELOG.md

@@ -3,7 +3,19 @@ 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.0.0...HEAD)
+# [Unreleased](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v14.1.0...HEAD)
+
+# [v14.1.0](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v14.0.1...v14.1.0)
+### Added
+* [PCM-1819](https://inindca.atlassian.net/browse/PCM-1819) Added separate backgroundassistant endpoints that will be used when using a screen recording jwt
+
+# [v14.0.1](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v14.0.0...v14.0.1)
+
+### Fixed
+* [PCM-1926](https://inindca.atlassian.net/browse/PCM-1926) – make sure that the `data` (ie. body) is sent with HTTP post & put requests.
+
+### Added
+* Added instance level version property. The streaming-client version can now be accessed statically or on constructed instances.
 
 # [v14.0.0](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v13.4.1...v14.0.0)
 ### Breaking Changes

package/dist/npm/client.d.ts

@@ -21,6 +21,8 @@ export declare class Client {
     deadChannels: string[];
     config: IClientConfig;
     streamId: any;
+    backgroundAssistantMode: boolean;
+    isGuest: boolean;
     http: HttpClient;
     notifications: NotificationsAPI;
     _notifications: Notifications;
@@ -30,6 +32,7 @@ export declare class Client {
     _ping: Ping;
     _reconnector: Reconnector;
     constructor(options: IClientOptions);
+    private checkIsBackgroundAssistant;
     cleanupLeakTimer(): void;
     on(eventName: any, ...args: any[]): this;
     once(eventName: any, ...args: any[]): this;
@@ -42,5 +45,6 @@ export declare class Client {
     startServerLogging(): void;
     setAccessToken(token: string): void;
     static extend(namespace: any, extension: StreamingClientExtension | ((client: Client) => void)): void;
+    get version(): string;
     static get version(): string;
 }

package/dist/npm/client.js

@@ -64,6 +64,8 @@ class Client {
         this.hardReconnectCount = 0;
         this.reconnectLeakTime = 1000 * 60 * 10; // 10 minutes
         this.deadChannels = [];
+        this.backgroundAssistantMode = false;
+        this.isGuest = false;
         this.http = new http_client_1.HttpClient();
         const stanzaio = stanza_1.createClient({});
         // TODO: remove this hack when we can. basically stanza messes up the auth mechanism priority.
@@ -82,12 +84,19 @@ class Client {
             appName: options.appName,
             appVersion: options.appVersion
         };
-        const accessToken = options.authToken || '';
+        this.backgroundAssistantMode = this.checkIsBackgroundAssistant();
+        this.isGuest = !this.backgroundAssistantMode && !options.authToken;
+        let loggerAccessToken = options.authToken || '';
+        let loggerUrl = `https://api.${this.config.apiHost}/api/v2/diagnostics/trace`;
+        if (this.backgroundAssistantMode) {
+            loggerAccessToken = options.jwt;
+            loggerUrl += '/backgroundassistant';
+        }
         this.logger = new genesys_cloud_client_logger_1.Logger({
-            accessToken,
-            url: `https://api.${this.config.apiHost}/api/v2/diagnostics/trace`,
+            accessToken: loggerAccessToken,
+            url: loggerUrl,
             uploadDebounceTime: 1000,
-            initializeServerLogging: !options.optOutOfWebrtcStatsTelemetry,
+            initializeServerLogging: !this.isGuest && !options.optOutOfWebrtcStatsTelemetry,
             /* streaming-client logging info */
             appVersion: Client.version,
             appName: 'streaming-client',
@@ -204,6 +213,13 @@ class Client {
             this[`_${extensionName}`] = extension;
         });
     }
+    checkIsBackgroundAssistant() {
+        if (this.config.jwt) {
+            const jwt = utils_1.parseJwt(this.config.jwt);
+            return jwt && jwt.iss === 'urn:purecloud:screenrecording';
+        }
+        return false;
+    }
     cleanupLeakTimer() {
         clearInterval(this.leakyReconnectTimer);
         this.leakyReconnectTimer = null;
@@ -349,8 +365,11 @@ class Client {
         }
         extensions[namespace] = extension;
     }
+    get version() {
+        return Client.version;
+    }
     static get version() {
-        return '14.0.1';
+        return '14.1.0';
     }
 }
 exports.Client = Client;

package/dist/npm/http-client.js

@@ -23,10 +23,9 @@ class HttpClient {
         const params = {
             method: opts.method,
             url,
+            data: opts.data,
             headers: {
-                'content-type': opts.contentType || 'application/json',
-                // we may not need this
-                'accept-encoding': 'gzip, deflate'
+                'content-type': opts.contentType || 'application/json'
             }
         };
         // default to include auth header

package/dist/npm/webrtc.js

@@ -157,7 +157,7 @@ class WebrtcExtension extends events_1.EventEmitter {
         }
         this.statsArr.splice(0, statsToSend.length);
         this.statBuffer = this.statsArr.reduce((currentSize, stats) => currentSize + utils_1.calculatePayloadSize(stats), 0);
-        if (!statsToSend.length || !this.client.config.authToken) {
+        if (!statsToSend.length || this.client.isGuest) {
             return;
         }
         const data = {
@@ -169,10 +169,16 @@ class WebrtcExtension extends events_1.EventEmitter {
         };
         // At least for now, we'll just fire and forget. Since this is non-critical, we'll not retry failures
         try {
-            await this.client.http.requestApi('diagnostics/newrelic/insights', {
+            let authToken = this.client.config.authToken;
+            let url = 'diagnostics/newrelic/insights';
+            if (this.client.backgroundAssistantMode) {
+                authToken = this.client.config.jwt;
+                url += '/backgroundassistant';
+            }
+            await this.client.http.requestApi(url, {
                 method: 'post',
                 host: this.client.config.apiHost,
-                authToken: this.client.config.authToken,
+                authToken,
                 logger: this.client.logger,
                 data
             });