@livedigital/client 2.12.0 → 2.14.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/dist/constants/common.d.ts +11 -0
  2. package/dist/engine/DefaultEngineDependenciesFactory.d.ts +3 -4
  3. package/dist/engine/Logger.d.ts +10 -3
  4. package/dist/engine/PeerConsumer.d.ts +6 -2
  5. package/dist/engine/handlers/MediaSoupEventHandler.d.ts +2 -0
  6. package/dist/engine/index.d.ts +10 -4
  7. package/dist/engine/media/index.d.ts +2 -0
  8. package/dist/engine/media/tracks/BaseTrack.d.ts +6 -2
  9. package/dist/engine/network/Socket.d.ts +5 -2
  10. package/dist/engine/network/index.d.ts +2 -0
  11. package/dist/engine/system/index.d.ts +2 -4
  12. package/dist/engine/wid/types.d.ts +1 -1
  13. package/dist/helpers/retry.d.ts +2 -0
  14. package/dist/index.d.ts +4 -1
  15. package/dist/index.es.js +1 -1
  16. package/dist/index.js +1 -1
  17. package/dist/types/common.d.ts +1 -0
  18. package/dist/types/engine.d.ts +15 -5
  19. package/package.json +2 -1
  20. package/src/constants/common.ts +13 -0
  21. package/src/engine/DefaultEngineDependenciesFactory.ts +18 -13
  22. package/src/engine/Logger.ts +43 -17
  23. package/src/engine/Peer.ts +10 -4
  24. package/src/engine/PeerConsumer.ts +12 -3
  25. package/src/engine/handlers/ChannelEventHandler.ts +4 -1
  26. package/src/engine/handlers/MediaSoupEventHandler.ts +42 -27
  27. package/src/engine/index.ts +43 -9
  28. package/src/engine/media/index.ts +17 -4
  29. package/src/engine/media/tracks/BaseTrack.ts +13 -3
  30. package/src/engine/media/tracks/PeerTrack.ts +5 -1
  31. package/src/engine/network/Socket.ts +10 -3
  32. package/src/engine/network/index.ts +6 -2
  33. package/src/engine/system/index.ts +7 -7
  34. package/src/engine/wid/WebRTCIssueDetector.ts +2 -2
  35. package/src/engine/wid/types.ts +1 -1
  36. package/src/helpers/retry.ts +4 -2
  37. package/src/index.ts +14 -1
  38. package/src/types/common.ts +2 -0
  39. package/src/types/engine.ts +18 -5
@@ -6,13 +6,14 @@ import {
6
6
  } from 'mediasoup-client/lib/Transport';
7
7
  import { Device } from 'mediasoup-client';
8
8
  import SocketIO from './Socket';
9
- import { ProduceParams } from '../../types/common';
9
+ import { LogLevel, ProduceParams } from '../../types/common';
10
10
  import LoadBalancerApiClient from './LoadBalancerClient';
11
11
  import { MEDIASOUP_EVENTS, MEDIASOUP_TRANSPORT_EVENTS } from '../../constants/events';
12
12
  import Logger from '../Logger';
13
13
 
14
14
  export type NetworkParams = {
15
15
  socketClient: SocketIO;
16
+ logLevel: LogLevel,
16
17
  loadBalancerApiClient: LoadBalancerApiClient;
17
18
  };
18
19
 
@@ -31,7 +32,10 @@ class Network {
31
32
  const { socketClient, loadBalancerApiClient } = params;
32
33
  this.socket = socketClient;
33
34
  this.loadBalancerClient = loadBalancerApiClient;
34
- this.logger = new Logger('Network');
35
+ this.logger = new Logger({
36
+ namespace: 'Network',
37
+ logLevel: params.logLevel,
38
+ });
35
39
  }
36
40
 
37
41
  async closeRemoteProducer(producerId: string): Promise<void> {
@@ -1,12 +1,9 @@
1
+ import { CreateSystemParams } from '../../types/engine';
1
2
  import { CLIENT_EVENTS } from '../../constants/events';
2
3
  import EnhancedEventEmitter from '../../EnhancedEventEmitter';
3
4
  import { AvailableMediaDevices } from '../../types/common';
4
5
  import Logger from '../Logger';
5
6
 
6
- type SystemParams = {
7
- clientEventEmitter: EnhancedEventEmitter,
8
- };
9
-
10
7
  class System {
11
8
  public isEnableVideoDevicesLock = false;
12
9
 
@@ -24,10 +21,13 @@ class System {
24
21
 
25
22
  private readonly logger: Logger;
26
23
 
27
- constructor(params: SystemParams) {
28
- const { clientEventEmitter } = params;
24
+ constructor(params: CreateSystemParams) {
25
+ const { clientEventEmitter, logLevel } = params;
29
26
  this.clientEventEmitter = clientEventEmitter;
30
- this.logger = new Logger('System');
27
+ this.logger = new Logger({
28
+ namespace: 'System',
29
+ logLevel,
30
+ });
31
31
  this.listenDevices();
32
32
  }
33
33
 
@@ -28,8 +28,8 @@ class WebRTCIssueDetector {
28
28
  #running = false;
29
29
 
30
30
  constructor(params: WebRTCIssueDetectorConstructorParams) {
31
- if (params.onIssue) {
32
- this.eventEmitter.on(EventType.Issue, params.onIssue);
31
+ if (params.onIssues) {
32
+ this.eventEmitter.on(EventType.Issue, params.onIssues);
33
33
  }
34
34
 
35
35
  // Move instantiation from the constructor
@@ -19,7 +19,7 @@ export enum EventType {
19
19
  export type EventPayload = IssueDetectorResult;
20
20
 
21
21
  export type WebRTCIssueDetectorConstructorParams = {
22
- onIssue?: (payload: IssueDetectorResult) => void,
22
+ onIssues?: (payload: IssueDetectorResult) => void,
23
23
  };
24
24
 
25
25
  export enum IssueType {
@@ -6,9 +6,9 @@ export type RetryOpts = {
6
6
  minBackoffDelayMs?: number;
7
7
  maxBackoffDelayMs?: number;
8
8
  actionName?: string; // human-readable action name for debug purposes
9
+ logger?: Logger;
9
10
  };
10
11
 
11
- const logger = new Logger('Retry');
12
12
  const timeProvider = new DefaultTimeProvider();
13
13
 
14
14
  const retryAsync = async <ReturnType>(
@@ -28,7 +28,9 @@ const retryAsync = async <ReturnType>(
28
28
  return await action();
29
29
  } catch (err: unknown) {
30
30
  lastError = err;
31
- logger.warn('Action retry failed', currentAttempt, opts.actionName, err);
31
+ if (opts.logger) {
32
+ opts.logger.info('Action retry failed', currentAttempt, opts.actionName, err);
33
+ }
32
34
 
33
35
  if (currentAttempt < maxRetries) {
34
36
  const delay = 2 ** (currentAttempt - 1) * minBackoffDelayMs;
package/src/index.ts CHANGED
@@ -4,6 +4,7 @@ import {
4
4
  CreateMicrophoneAudioTrackOptions,
5
5
  CreateScreenMediaOptions,
6
6
  JoinChannelParams,
7
+ LogLevel,
7
8
  LogMessageHandler,
8
9
  Role,
9
10
  Track,
@@ -13,13 +14,16 @@ import Engine from './engine';
13
14
  import Peer from './engine/Peer';
14
15
  import { LoadBalancerApiClientParams } from './engine/network/LoadBalancerClient';
15
16
  import DefaultEngineDependenciesFactory from './engine/DefaultEngineDependenciesFactory';
17
+ import { IssuesHandler } from './types/engine';
16
18
 
17
19
  type ClientParams = {
18
20
  observer?: EnhancedEventEmitter;
19
21
  network?: {
20
22
  loadbalancer?: LoadBalancerApiClientParams;
21
23
  },
24
+ logLevel: LogLevel,
22
25
  onLogMessage?: LogMessageHandler;
26
+ onIssues?: IssuesHandler,
23
27
  };
24
28
 
25
29
  class Client {
@@ -28,7 +32,14 @@ class Client {
28
32
  private readonly _observer: EnhancedEventEmitter;
29
33
 
30
34
  constructor(params: ClientParams) {
31
- const { observer, network, onLogMessage } = params;
35
+ const {
36
+ observer,
37
+ network,
38
+ onLogMessage,
39
+ onIssues,
40
+ logLevel,
41
+ } = params;
42
+
32
43
  this._observer = observer ?? new EnhancedEventEmitter();
33
44
  const dependenciesFactory = new DefaultEngineDependenciesFactory();
34
45
  this.engine = new Engine({
@@ -40,7 +51,9 @@ class Client {
40
51
  customNode: network?.loadbalancer?.customNode,
41
52
  },
42
53
  },
54
+ logLevel,
43
55
  onLogMessage,
56
+ onIssues,
44
57
  });
45
58
  }
46
59
 
@@ -233,3 +233,5 @@ export type RemoteConsumerOptions = ConsumerOptions & {
233
233
  };
234
234
 
235
235
  export type LogMessageHandler = (msg: any, ...meta: any) => void;
236
+
237
+ export type LogLevel = 3 | 4 | 6 | 7;
@@ -7,20 +7,33 @@ import ChannelEventHandler from '../engine/handlers/ChannelEventHandler';
7
7
  import MediaSoupEventHandler from '../engine/handlers/MediaSoupEventHandler';
8
8
  import WebRTCIssueDetector from '../engine/wid/WebRTCIssueDetector';
9
9
  import { LoadBalancerApiClientParams } from '../engine/network/LoadBalancerClient';
10
- import Logger from '../engine/Logger';
10
+ import { IssueDetectorResult } from '../engine/wid/types';
11
+ import { LogLevel } from './common';
12
+
13
+ export type IssuesHandler = (issues: IssueDetectorResult) => void;
11
14
 
12
15
  export interface CreateIssueDetectorParams {
13
- logger: Logger;
16
+ onIssues?: IssuesHandler;
17
+ }
18
+
19
+ export interface CreateMediaParams {
20
+ logLevel: LogLevel;
14
21
  }
15
22
 
16
23
  export interface CreateNetworkParams {
24
+ logLevel: LogLevel;
17
25
  loadbalancer: LoadBalancerApiClientParams;
18
26
  }
19
27
 
28
+ export interface CreateSystemParams {
29
+ logLevel: LogLevel;
30
+ clientEventEmitter: EnhancedEventEmitter
31
+ }
32
+
20
33
  export interface EngineDependenciesFactory {
21
- createSystem: (clientEventEmitter: EnhancedEventEmitter) => System;
22
- createMedia: () => Media;
23
- createNetwork: (networkParams: CreateNetworkParams) => Network;
34
+ createSystem: (params: CreateSystemParams) => System;
35
+ createMedia: (params: CreateMediaParams) => Media;
36
+ createNetwork: (params: CreateNetworkParams) => Network;
24
37
  createChannelEventHandler: (engine: Engine) => ChannelEventHandler;
25
38
  createMediaSoupEventHandler: (engine: Engine) => MediaSoupEventHandler;
26
39
  createIssueDetector: (params: CreateIssueDetectorParams) => WebRTCIssueDetector;