@livedigital/client 3.48.0 → 3.49.0

package/src/engine/system/index.ts

@@ -1,221 +0,0 @@
-import { inject, injectable } from 'inversify';
-import { CLIENT_EVENTS } from '../../constants/events';
-import EnhancedEventEmitter from '../../EnhancedEventEmitter';
-import { TOKEN } from '../../inversify.tokens';
-import { AvailableMediaDevices, DeviceErrors } from '../../types/common';
-import Logger from '../Logger';
-
-const isUnexpectedError = (errorMessage: string): boolean => {
-  const errors: string[] = [
-    DeviceErrors.NotFoundError,
-    DeviceErrors.NotAllowedError,
-    DeviceErrors.DeviceIsBusy,
-  ];
-
-  return !errors.includes(errorMessage);
-};
-
-const getDeviceErrorCode = (error: unknown): string | undefined => {
-  if (error instanceof Error) {
-    return error.message;
-  }
-
-  if (typeof error === 'string') {
-    return error;
-  }
-
-  if (error && typeof error === 'object' && 'message' in error) {
-    const maybeMessage = (error as { message?: unknown }).message;
-
-    return typeof maybeMessage === 'string' ? maybeMessage : undefined;
-  }
-
-  return undefined;
-};
-
-@injectable()
-class System {
-  public isEnableVideoDevicesLock = false;
-
-  public isEnableAudioDevicesLock = false;
-
-  public isDevicesDetected = false;
-
-  public availableVideoDevices: MediaDeviceInfo[] = [];
-
-  public availableAudioDevices: MediaDeviceInfo[] = [];
-
-  readonly #logger: Logger;
-
-  constructor(
-    @inject(TOKEN.ClientEventEmitter) private readonly clientEventEmitter: EnhancedEventEmitter,
-    @inject(TOKEN.LoggerFactory) loggerFactory: (namespace: string) => Logger,
-  ) {
-    this.#logger = loggerFactory('System');
-
-    this.deviceChangeHandler = this.deviceChangeHandler.bind(this);
-
-    this.listenDevices();
-  }
-
-  setIsEnableVideoDevicesLock(value: boolean): void {
-    this.isEnableVideoDevicesLock = value;
-  }
-
-  setIsEnableAudioDevicesLock(value: boolean): void {
-    this.isEnableAudioDevicesLock = value;
-  }
-
-  setAvailableVideoDevices(availableVideoDevices: MediaDeviceInfo[]): void {
-    this.availableVideoDevices = availableVideoDevices;
-  }
-
-  setAvailableAudioDevices(availableAudioDevices: MediaDeviceInfo[]): void {
-    this.availableAudioDevices = availableAudioDevices;
-  }
-
-  async requestMediaDevicesAccess(
-    constraints: MediaStreamConstraints = { video: true, audio: true },
-  ): Promise<MediaStreamTrack[]> {
-    try {
-      const stream = await navigator.mediaDevices.getUserMedia(constraints);
-
-      return stream.getTracks();
-    } catch (error) {
-      this.#logger.error('getUserMedia()', { error, constraints });
-
-      const errorName = error instanceof Error ? error.name : undefined;
-
-      if (errorName === 'NotAllowedError') {
-        throw new Error(DeviceErrors.NotAllowedError);
-      }
-
-      if (errorName === 'NotReadableError') {
-        throw new Error(DeviceErrors.DeviceIsBusy);
-      }
-
-      if (errorName === 'NotFoundError') {
-        throw new Error(DeviceErrors.NotFoundError);
-      }
-
-      throw new Error(DeviceErrors.RequestDevicesUnknownError);
-    }
-  }
-
-  async hasAvailableMediaDevicesList(): Promise<boolean> {
-    const devices = await navigator.mediaDevices.enumerateDevices();
-
-    if (devices.length === 0) {
-      return true;
-    }
-
-    /* this checks on browser level, will succeed if allowed in browser, but denied by OS */
-    const hasDevicesList = devices.every((device) => device.deviceId && device.label);
-
-    return hasDevicesList;
-  }
-
-  async refreshAvailableMediaDevicesList(): Promise<MediaDeviceInfo[]> {
-    const devices = await navigator.mediaDevices.enumerateDevices();
-    const videoDevices = [] as MediaDeviceInfo[];
-    const audioDevices = [] as MediaDeviceInfo[];
-    devices.forEach((device) => {
-      if (device.deviceId === '') {
-        return;
-      }
-
-      if (device.kind === 'videoinput') {
-        videoDevices.push(device);
-      }
-
-      if (device.kind === 'audioinput') {
-        audioDevices.push(device);
-      }
-    });
-
-    this.setAvailableVideoDevices(videoDevices);
-    this.setAvailableAudioDevices(audioDevices);
-
-    const mapDeviceInfo = ({ label, kind }: MediaDeviceInfo): { label: string; kind: MediaDeviceKind } => ({
-      label,
-      kind,
-    });
-
-    this.#logger.debug('Devices list updated', {
-      videoDevices: videoDevices.map(mapDeviceInfo),
-      audioDevices: audioDevices.map(mapDeviceInfo),
-    });
-
-    return devices;
-  }
-
-  async detectDevices(force?: boolean): Promise<void> {
-    if (this.isDevicesDetected && !force) {
-      return;
-    }
-
-    const hasAvailableMediaDevicesList = await this.hasAvailableMediaDevicesList();
-
-    if (!hasAvailableMediaDevicesList) {
-      await this.tryToAccessDevices();
-    }
-
-    // at this moment an access to devices were granted or no devices exist
-    this.isDevicesDetected = true;
-
-    const rawDevices = await this.refreshAvailableMediaDevicesList();
-    const hasAudioInputDevices = rawDevices.some((x) => x.kind === 'audioinput');
-    const hasVideoInputDevices = rawDevices.some((x) => x.kind === 'videoinput');
-
-    if (!hasAudioInputDevices && !hasVideoInputDevices) {
-      throw new Error(DeviceErrors.NoDevices);
-    }
-  }
-
-  async deviceChangeHandler(): Promise<void> {
-    if (!this.isDevicesDetected) {
-      return;
-    }
-
-    await this.refreshAvailableMediaDevicesList();
-
-    const payload: AvailableMediaDevices = {
-      audio: this.availableAudioDevices,
-      video: this.availableVideoDevices,
-    };
-    this.clientEventEmitter.safeEmit(CLIENT_EVENTS.devicesListUpdated, payload);
-  }
-
-  listenDevices(): void {
-    // eslint-disable-next-line @typescript-eslint/unbound-method
-    navigator.mediaDevices.addEventListener('devicechange', this.deviceChangeHandler);
-  }
-
-  private async assertHasAccessToMediaDevices(
-    constraints: MediaStreamConstraints = { video: true, audio: true },
-  ): Promise<void> {
-    const tracks = await this.requestMediaDevicesAccess(constraints);
-    tracks.forEach((track) => track.stop());
-  }
-
-  private async tryToAccessDevices(): Promise<void> {
-    try {
-      const tracks = await this.requestMediaDevicesAccess();
-      tracks.forEach((track) => track.stop());
-    } catch (error) {
-      const errorCode = getDeviceErrorCode(error);
-
-      if (!errorCode || isUnexpectedError(errorCode)) {
-        throw error;
-      }
-
-      /* if device is busy that means we have permissions */
-      if (errorCode !== DeviceErrors.DeviceIsBusy) {
-        await this.assertHasAccessToMediaDevices({ audio: true });
-        await this.assertHasAccessToMediaDevices({ video: true });
-      }
-    }
-  }
-}
-
-export default System;

package/src/errors/AlreadyConnectedError.ts

@@ -1,11 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class AlreadyConnectedError extends LivedigitalSDKError {
-  static readonly DEFAULT_MESSAGE = 'Peer is already connected';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? AlreadyConnectedError.DEFAULT_MESSAGE, errorCode ?? 'already_connected', meta);
-  }
-}
-
-export default AlreadyConnectedError;

package/src/errors/AlreadyCreatedError.ts

@@ -1,11 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class AlreadyCreatedError extends LivedigitalSDKError {
-  static readonly DEFAULT_MESSAGE = 'Resource has already been created';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? AlreadyCreatedError.DEFAULT_MESSAGE, errorCode ?? 'already_created', meta);
-  }
-}
-
-export default AlreadyCreatedError;

package/src/errors/ForbiddenError.ts

@@ -1,11 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class ForbiddenError extends LivedigitalSDKError {
-  static readonly DEFAULT_MESSAGE = 'Forbidden';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? ForbiddenError.DEFAULT_MESSAGE, errorCode ?? 'forbidden', meta);
-  }
-}
-
-export default ForbiddenError;

package/src/errors/InvalidPayloadError.ts

@@ -1,11 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class InvalidPayloadError extends LivedigitalSDKError {
-  static readonly DEFAULT_MESSAGE: string = 'Invalid payload';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? InvalidPayloadError.DEFAULT_MESSAGE, errorCode ?? 'invalid_payload', meta);
-  }
-}
-
-export default InvalidPayloadError;

package/src/errors/InvalidRequestError.ts

@@ -1,11 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class InvalidRequestError extends LivedigitalSDKError {
-  static readonly DEFAULT_MESSAGE: string = 'Invalid request';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? InvalidRequestError.DEFAULT_MESSAGE, errorCode ?? 'invalid_request', meta);
-  }
-}
-
-export default InvalidRequestError;

package/src/errors/LivedigitalSDKError.ts

@@ -1,15 +0,0 @@
-class LivedigitalSDKError extends Error {
-  readonly errorCode: string;
-
-  readonly meta?: Record<string, unknown>;
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? 'Unexpected Livedigital SDK error');
-    Object.setPrototypeOf(this, new.target.prototype);
-    this.name = new.target.name;
-    this.errorCode = errorCode ?? 'unknown_error';
-    this.meta = meta;
-  }
-}
-
-export default LivedigitalSDKError;

package/src/errors/NeedJoinFirstError.ts

@@ -1,11 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class NeedJoinFirstError extends LivedigitalSDKError {
-  static readonly DEFAULT_MESSAGE = 'Peer must join the channel before performing this request';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? NeedJoinFirstError.DEFAULT_MESSAGE, errorCode ?? 'need_joined_to_channel', meta);
-  }
-}
-
-export default NeedJoinFirstError;

package/src/errors/NotFoundError.ts

@@ -1,11 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class NotFoundError extends LivedigitalSDKError {
-  static readonly DEFAULT_MESSAGE = 'Requested resource was not found';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? NotFoundError.DEFAULT_MESSAGE, errorCode ?? 'not_found', meta);
-  }
-}
-
-export default NotFoundError;

package/src/errors/OperationError.ts

@@ -1,47 +0,0 @@
-import { serializeError } from 'serialize-error';
-
-const getMessageFromCause = (cause?: unknown): string | undefined => {
-  if (typeof cause === 'string') {
-    return cause;
-  }
-
-  if (cause instanceof Error) {
-    return cause.message;
-  }
-
-  if (cause && typeof cause === 'object' && 'message' in cause) {
-    const maybeMessage = (cause as { message?: unknown }).message;
-
-    return typeof maybeMessage === 'string' ? maybeMessage : undefined;
-  }
-
-  return undefined;
-};
-
-class OperationError extends Error {
-  readonly errorCode: string;
-
-  readonly cause: unknown;
-
-  constructor(errorCode: string, cause?: unknown) {
-    if (cause instanceof OperationError) {
-      super(cause.message);
-      Object.setPrototypeOf(this, new.target.prototype);
-      this.name = new.target.name;
-      this.errorCode = cause.errorCode;
-      this.cause = cause.cause;
-
-      return;
-    }
-
-    const internalError = serializeError(cause);
-    const message = getMessageFromCause(internalError) ?? 'Operation failed';
-    super(message);
-    Object.setPrototypeOf(this, new.target.prototype);
-    this.name = new.target.name;
-    this.errorCode = errorCode;
-    this.cause = serializeError(internalError);
-  }
-}
-
-export default OperationError;

package/src/errors/RequestError.ts

@@ -1,11 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class RequestError extends LivedigitalSDKError {
-  static readonly DEFAULT_MESSAGE = 'Request failed';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? RequestError.DEFAULT_MESSAGE, errorCode ?? 'something_went_wrong', meta);
-  }
-}
-
-export default RequestError;

package/src/errors/TimeoutError.ts

@@ -1,11 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class TimeoutError extends LivedigitalSDKError {
-  static readonly DEFAULT_MESSAGE = 'Request timed out';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? TimeoutError.DEFAULT_MESSAGE, errorCode ?? 'timeout', meta);
-  }
-}
-
-export default TimeoutError;

package/src/errors/TooManyRequestsError.ts

@@ -1,11 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class TooManyRequestsError extends LivedigitalSDKError {
-  static readonly DEFAULT_MESSAGE = 'Too many requests';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? TooManyRequestsError.DEFAULT_MESSAGE, errorCode ?? 'too_many_requests', meta);
-  }
-}
-
-export default TooManyRequestsError;

package/src/errors/UnauthorizedError.ts

@@ -1,11 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class UnauthorizedError extends LivedigitalSDKError {
-  static readonly DEFAULT_MESSAGE = 'Unauthorized';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? UnauthorizedError.DEFAULT_MESSAGE, errorCode ?? 'unauthorized', meta);
-  }
-}
-
-export default UnauthorizedError;

package/src/errors/UnsupportedError.ts

@@ -1,15 +0,0 @@
-import LivedigitalSDKError from './LivedigitalSDKError';
-
-class UnsupportedError extends LivedigitalSDKError {
-  static readonly UNSUPPORTED_DEVICE_CODE = 'unsupported_device_error';
-
-  static readonly UNSUPPORTED_OPERATION_CODE = 'unsupported_operation_error';
-
-  static readonly DEFAULT_MESSAGE = 'Unsupported operation';
-
-  constructor(msg?: string, errorCode?: string, meta?: Record<string, unknown>) {
-    super(msg ?? UnsupportedError.DEFAULT_MESSAGE, errorCode ?? 'unsupported_error', meta);
-  }
-}
-
-export default UnsupportedError;

package/src/errors/signalingApiErrorMapper.ts

@@ -1,143 +0,0 @@
-import axios from 'axios';
-import type { AxiosError } from 'axios';
-import AlreadyConnectedError from './AlreadyConnectedError';
-import AlreadyCreatedError from './AlreadyCreatedError';
-import ForbiddenError from './ForbiddenError';
-import InvalidRequestError from './InvalidRequestError';
-import type LivedigitalSDKError from './LivedigitalSDKError';
-import NeedJoinFirstError from './NeedJoinFirstError';
-import NotFoundError from './NotFoundError';
-import RequestError from './RequestError';
-import TimeoutError from './TimeoutError';
-import TooManyRequestsError from './TooManyRequestsError';
-import UnauthorizedError from './UnauthorizedError';
-
-interface ErrorResponseBody {
-  error?: string;
-  errorCode?: string;
-  [key: string]: unknown;
-}
-
-type ErrorFactory = (
-  message: string,
-  errorCode: string,
-  meta?: Record<string, unknown>,
-) => LivedigitalSDKError;
-
-type ErrorConstructor = new (
-  message?: string,
-  errorCode?: string,
-  meta?: Record<string, unknown>,
-) => LivedigitalSDKError;
-
-const createFactory = (Ctor: ErrorConstructor): ErrorFactory => (message, errorCode, meta) =>
-  new Ctor(message, errorCode, meta);
-
-const ERROR_FACTORIES: Record<string, ErrorFactory> = {
-  check_access_fail: createFactory(ForbiddenError),
-  join_room_fail: createFactory(InvalidRequestError),
-  need_joined_to_channel: createFactory(NeedJoinFirstError),
-  forbidden: createFactory(ForbiddenError),
-  not_found: createFactory(NotFoundError),
-  invalid_request: createFactory(InvalidRequestError),
-  invalid_payload: createFactory(InvalidRequestError),
-  already_created: createFactory(AlreadyCreatedError),
-  too_many_requests: createFactory(TooManyRequestsError),
-  something_went_wrong: createFactory(RequestError),
-  di_error: createFactory(InvalidRequestError),
-  resources_lock_error: createFactory(InvalidRequestError),
-  already_connected: createFactory(AlreadyConnectedError),
-  timeout: createFactory(TimeoutError),
-  unauthorized: createFactory(UnauthorizedError),
-};
-
-const isRecord = (value: unknown): value is Record<string, unknown> =>
-  typeof value === 'object' && value !== null && !Array.isArray(value);
-
-const isErrorResponseBody = (value: unknown): value is ErrorResponseBody => {
-  if (!isRecord(value)) {
-    return false;
-  }
-
-  const { error, errorCode } = value;
-
-  return (error === undefined || typeof error === 'string')
-    && (errorCode === undefined || typeof errorCode === 'string');
-};
-
-const buildMeta = (
-  error: AxiosError<ErrorResponseBody>,
-  payload?: ErrorResponseBody,
-): Record<string, unknown> | undefined => {
-  const meta: Record<string, unknown> = {};
-
-  if (payload && Object.keys(payload).length > 0) {
-    meta.response = payload;
-  }
-
-  if (typeof error.response?.status === 'number') {
-    meta.status = error.response.status;
-  }
-
-  if (error.response?.statusText) {
-    meta.statusText = error.response.statusText;
-  }
-
-  if (error.code) {
-    meta.axiosCode = error.code;
-  }
-
-  if (error.config?.url) {
-    meta.url = error.config.url;
-  }
-
-  if (error.config?.method) {
-    meta.method = error.config.method;
-  }
-
-  return Object.keys(meta).length > 0 ? meta : undefined;
-};
-
-export const mapSignalingApiError = (error: unknown): Error => {
-  if (!axios.isAxiosError(error)) {
-    return error instanceof Error ? error : new RequestError();
-  }
-
-  const axiosError = error as AxiosError<ErrorResponseBody>;
-
-  if (!axiosError.response) {
-    const meta = buildMeta(axiosError);
-    const message = axiosError.message || RequestError.DEFAULT_MESSAGE;
-    const errorCode = axiosError.code ?? 'network_error';
-
-    return new RequestError(message, errorCode, meta);
-  }
-
-  const payload = isErrorResponseBody(axiosError.response.data) ? axiosError.response.data : undefined;
-
-  const errorCode = typeof payload?.errorCode === 'string' ? payload.errorCode : undefined;
-
-  const messageFromPayload = typeof payload?.error === 'string' ? payload.error : undefined;
-  const message =
-    (messageFromPayload && messageFromPayload.trim().length > 0
-      ? messageFromPayload
-      : axiosError.message) || RequestError.DEFAULT_MESSAGE;
-
-  const meta = buildMeta(axiosError, payload);
-
-  if (errorCode) {
-    const factory = ERROR_FACTORIES[errorCode];
-
-    return factory ? factory(message, errorCode, meta) : new RequestError(message, errorCode, meta);
-  }
-
-  const fallbackCode =
-    axiosError.code ??
-    (typeof axiosError.response.status === 'number'
-      ? `http_${ axiosError.response.status }`
-      : 'something_went_wrong');
-
-  return new RequestError(message, fallbackCode, meta);
-};
-
-export default mapSignalingApiError;

package/src/helpers/appDataValidator.ts

@@ -1,21 +0,0 @@
-import { PEER_APP_DATA_MAX_SIZE_BYTES } from '../constants/common';
-
-const validateAppData = (appData: Record<string, unknown>): void => {
-  let validStringifiesJsonAppData: string | undefined = undefined;
-
-  try {
-    validStringifiesJsonAppData = JSON.stringify(appData);
-  } catch {
-    throw new Error('Invalid appData');
-  }
-
-  const size = new TextEncoder().encode(validStringifiesJsonAppData).length;
-
-  if (size <= PEER_APP_DATA_MAX_SIZE_BYTES) {
-    return;
-  }
-
-  throw new Error('Maximum size appData reached');
-};
-
-export default validateAppData;

package/src/helpers/browser.ts

@@ -1,37 +0,0 @@
-import Bowser from 'bowser';
-
-export interface BrowserEnvironment {
-  isMobile: boolean;
-  isChromiumBased: boolean;
-}
-
-export const detectBrowserEnvironment = (userAgent?: string): BrowserEnvironment => {
-  const ua = userAgent ?? (typeof navigator !== 'undefined' ? navigator.userAgent : undefined);
-
-  if (!ua) {
-    return { isMobile: false, isChromiumBased: false };
-  }
-
-  const parser = Bowser.getParser(ua);
-  const platformType = parser.getPlatformType(true);
-  const isMobile = platformType === 'mobile' || platformType === 'tablet';
-
-  const engineName = parser.getEngineName().toLowerCase();
-  const isChromiumFamily = parser.satisfies({
-    chrome: '>=0',
-    chromium: '>=0',
-    'chromium webview': '>=0',
-    edge: '>=0',
-    opera: '>=0',
-    'opera coast': '>=0',
-    'samsung internet for android': '>=0',
-    'yandex browser': '>=0',
-    electron: '>=0',
-  }) ?? false;
-
-  const isChromiumBased = engineName === 'blink' || (isChromiumFamily && engineName !== 'webkit');
-
-  return { isMobile, isChromiumBased };
-};
-
-export const isSafari = (): boolean => /apple/i.test(navigator.vendor);