genesys-cloud-streaming-client 16.1.0 → 16.1.2-develop.66

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

@@ -156,37 +156,33 @@ export declare type GenesysSessionTerminateParams = GenesysWebrtcBaseParams & {
 export declare type GenesysWebrtcMuteParams = GenesysWebrtcBaseParams & {
     type: 'audio' | 'video';
 };
-export declare type JsonRpcMessage<T> = {
+export declare type TypedJsonRpcMessage<Method extends string, Params> = {
     jsonrpc: string;
-    method: keyof T;
+    method: Method;
     id?: string;
-} & (T[keyof T] extends undefined ? {
-    params?: T[keyof T];
-} : {
-    params: T[keyof T];
-});
-export declare type GenesysWebrtcParams = {
-    offer: GenesysWebrtcOfferParams;
-    answer: GenesysWebrtcSdpParams;
-    info: GenesysInfoActiveParams;
-    iceCandidate: GenesysWebrtcSdpParams;
-    terminate: GenesysSessionTerminateParams;
-    mute: GenesysWebrtcMuteParams;
-    unmute: GenesysWebrtcMuteParams;
+    params?: Params;
 };
-export declare type GenesysWebrtcJsonRpcMessage = JsonRpcMessage<GenesysWebrtcParams>;
+export declare type JsonRpcMessage = TypedJsonRpcMessage<string, any>;
+export declare type GenesysWebrtcOffer = TypedJsonRpcMessage<'offer', GenesysWebrtcOfferParams>;
+export declare type GenesysWebrtcAnswer = TypedJsonRpcMessage<'answer', GenesysWebrtcSdpParams>;
+export declare type GenesysWebrtcInfo = TypedJsonRpcMessage<'info', GenesysInfoActiveParams>;
+export declare type GenesysWebrtcIceCandidate = TypedJsonRpcMessage<'iceCandidate', GenesysWebrtcSdpParams>;
+export declare type GenesysWebrtcTerminate = TypedJsonRpcMessage<'terminate', GenesysSessionTerminateParams>;
+export declare type GenesysWebrtcMute = TypedJsonRpcMessage<'mute', GenesysWebrtcMuteParams>;
+export declare type GenesysWebrtcUnmute = TypedJsonRpcMessage<'unmute', GenesysWebrtcMuteParams>;
+export declare type GenesysWebrtcJsonRpcMessage = GenesysWebrtcOffer | GenesysWebrtcAnswer | GenesysWebrtcInfo | GenesysWebrtcIceCandidate | GenesysWebrtcTerminate | GenesysWebrtcMute | GenesysWebrtcUnmute;
 export declare type HeadsetControlsRequestType = 'mediaHelper' | 'standard' | 'prioritized';
 export declare type HeadsetControlsRejectionReason = 'activeCall' | 'mediaHelper' | 'priority';
-export declare type GenesysMediaMessageParams = {
-    headsetControlsRequest: {
-        requestType: HeadsetControlsRequestType;
-    };
-    headsetControlsRejection: {
-        requestId: string;
-        reason: HeadsetControlsRejectionReason;
-    };
-    headsetControlsChanged: {
-        hasControls: boolean;
-    };
+export declare type HeadsetControlsRejectionParams = {
+    requestId: string;
+    reason: HeadsetControlsRejectionReason;
+};
+export declare type HeadsetControlsChangedParams = {
+    hasControls: boolean;
 };
-export declare type GenesysMediaMessage = JsonRpcMessage<GenesysMediaMessageParams>;
+export declare type HeadsetControlsRequest = TypedJsonRpcMessage<'headsetControlsRequest', {
+    requestType: HeadsetControlsRequestType;
+}>;
+export declare type HeadsetControlsRejection = TypedJsonRpcMessage<'headsetControlsRejection', HeadsetControlsRejectionParams>;
+export declare type HeadsetControlsChanged = TypedJsonRpcMessage<'headsetControlsChanged', HeadsetControlsChangedParams>;
+export declare type GenesysMediaMessage = HeadsetControlsRequest | HeadsetControlsRejection | HeadsetControlsChanged;

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

@@ -24,7 +24,7 @@ export interface SessionEvents {
     terminated: JingleReason;
     stats: StatsEvent;
     endOfCandidates: void;
-    dataChannelMessage: JsonRpcMessage<any>;
+    dataChannelMessage: JsonRpcMessage;
 }
 export interface IMediaSessionParams {
     logger: Logger;

package/dist/npm/CHANGELOG.md

@@ -4,7 +4,12 @@ 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/v16.1.0...HEAD)
+# [Unreleased](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v16.1.1...HEAD)
+* [PCM-2223](https://inindca.atlassian.net/browse/PCM-2223) Fix unintentional breaking change with types
+
+# [v16.1.1](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v16.1.0...v16.1.1)
+### Added
+* [PCM-2262](https://inindca.atlassian.net/browse/PCM-2262) Fixed snyk vulnerability SNYK-JS-AXIOS-6032459
 
 # [v16.1.0](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v16.0.2...v16.1.0)
 ### Added

package/dist/npm/client.js

@@ -242,7 +242,7 @@ class Client extends events_1.default {
             }
             else if (err.name === 'AxiosError') {
                 const axiosError = err;
-                const config = axiosError.config;
+                const config = axiosError.config || { url: undefined, method: undefined };
                 // sanitized error for logging
                 error = {
                     config: {
@@ -275,7 +275,7 @@ class Client extends events_1.default {
         }
         else if (err.name === 'AxiosError') {
             const axiosError = err;
-            const config = axiosError.config;
+            const config = axiosError.config || { url: undefined, method: undefined };
             let sanitizedError = {
                 config: {
                     url: config.url,
@@ -433,7 +433,7 @@ class Client extends events_1.default {
         return Client.version;
     }
     static get version() {
-        return '16.1.0';
+        return '16.1.2';
     }
 }
 exports.Client = Client;

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

@@ -156,37 +156,33 @@ export declare type GenesysSessionTerminateParams = GenesysWebrtcBaseParams & {
 export declare type GenesysWebrtcMuteParams = GenesysWebrtcBaseParams & {
     type: 'audio' | 'video';
 };
-export declare type JsonRpcMessage<T> = {
+export declare type TypedJsonRpcMessage<Method extends string, Params> = {
     jsonrpc: string;
-    method: keyof T;
+    method: Method;
     id?: string;
-} & (T[keyof T] extends undefined ? {
-    params?: T[keyof T];
-} : {
-    params: T[keyof T];
-});
-export declare type GenesysWebrtcParams = {
-    offer: GenesysWebrtcOfferParams;
-    answer: GenesysWebrtcSdpParams;
-    info: GenesysInfoActiveParams;
-    iceCandidate: GenesysWebrtcSdpParams;
-    terminate: GenesysSessionTerminateParams;
-    mute: GenesysWebrtcMuteParams;
-    unmute: GenesysWebrtcMuteParams;
+    params?: Params;
 };
-export declare type GenesysWebrtcJsonRpcMessage = JsonRpcMessage<GenesysWebrtcParams>;
+export declare type JsonRpcMessage = TypedJsonRpcMessage<string, any>;
+export declare type GenesysWebrtcOffer = TypedJsonRpcMessage<'offer', GenesysWebrtcOfferParams>;
+export declare type GenesysWebrtcAnswer = TypedJsonRpcMessage<'answer', GenesysWebrtcSdpParams>;
+export declare type GenesysWebrtcInfo = TypedJsonRpcMessage<'info', GenesysInfoActiveParams>;
+export declare type GenesysWebrtcIceCandidate = TypedJsonRpcMessage<'iceCandidate', GenesysWebrtcSdpParams>;
+export declare type GenesysWebrtcTerminate = TypedJsonRpcMessage<'terminate', GenesysSessionTerminateParams>;
+export declare type GenesysWebrtcMute = TypedJsonRpcMessage<'mute', GenesysWebrtcMuteParams>;
+export declare type GenesysWebrtcUnmute = TypedJsonRpcMessage<'unmute', GenesysWebrtcMuteParams>;
+export declare type GenesysWebrtcJsonRpcMessage = GenesysWebrtcOffer | GenesysWebrtcAnswer | GenesysWebrtcInfo | GenesysWebrtcIceCandidate | GenesysWebrtcTerminate | GenesysWebrtcMute | GenesysWebrtcUnmute;
 export declare type HeadsetControlsRequestType = 'mediaHelper' | 'standard' | 'prioritized';
 export declare type HeadsetControlsRejectionReason = 'activeCall' | 'mediaHelper' | 'priority';
-export declare type GenesysMediaMessageParams = {
-    headsetControlsRequest: {
-        requestType: HeadsetControlsRequestType;
-    };
-    headsetControlsRejection: {
-        requestId: string;
-        reason: HeadsetControlsRejectionReason;
-    };
-    headsetControlsChanged: {
-        hasControls: boolean;
-    };
+export declare type HeadsetControlsRejectionParams = {
+    requestId: string;
+    reason: HeadsetControlsRejectionReason;
+};
+export declare type HeadsetControlsChangedParams = {
+    hasControls: boolean;
 };
-export declare type GenesysMediaMessage = JsonRpcMessage<GenesysMediaMessageParams>;
+export declare type HeadsetControlsRequest = TypedJsonRpcMessage<'headsetControlsRequest', {
+    requestType: HeadsetControlsRequestType;
+}>;
+export declare type HeadsetControlsRejection = TypedJsonRpcMessage<'headsetControlsRejection', HeadsetControlsRejectionParams>;
+export declare type HeadsetControlsChanged = TypedJsonRpcMessage<'headsetControlsChanged', HeadsetControlsChangedParams>;
+export declare type GenesysMediaMessage = HeadsetControlsRequest | HeadsetControlsRejection | HeadsetControlsChanged;

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

@@ -24,7 +24,7 @@ export interface SessionEvents {
     terminated: JingleReason;
     stats: StatsEvent;
     endOfCandidates: void;
-    dataChannelMessage: JsonRpcMessage<any>;
+    dataChannelMessage: JsonRpcMessage;
 }
 export interface IMediaSessionParams {
     logger: Logger;