@playkit-js/playkit-js-providers 2.39.1 → 2.39.2

package/src/entities/media-entry.js

@@ -1,96 +0,0 @@
-//@flow
-import MediaSources from './media-sources';
-
-export default class MediaEntry {
-  static Type: {[type: string]: string} = {
-    VOD: 'Vod',
-    LIVE: 'Live',
-    IMAGE: 'Image',
-    AUDIO: 'Audio',
-    UNKNOWN: 'Unknown'
-  };
-  static DvrStatus: {[type: string]: number} = {
-    ON: 1,
-    OFF: 0
-  };
-
-  /**
-   * @member - entry id
-   * @type {string}
-   */
-  id: string;
-  /**
-   * @member - entry name
-   * @type {string}
-   */
-  name: string;
-  /**
-   * @member - entry sources
-   * @type {MediaSources}
-   */
-  sources: MediaSources;
-  /**
-   * @member - entry duration
-   * @type {number}
-   */
-  duration: number;
-  /**
-   * @member - entry type
-   * @type {string}
-   */
-  type: string;
-  /**
-   * @member - entry metadata
-   * @type {Object}
-   */
-  metadata: Object;
-  /**
-   * @member - DVR status
-   * @type {number}
-   */
-  dvrStatus: number;
-  /**
-   * @member - media status
-   * @type {number}
-   */
-  status: number;
-  /**
-   * @member - media poster
-   * @type {string | Array<Object>}
-   */
-  poster: string | Array<Object>;
-
-  /**
-   * @member - assetReferenceType
-   * @type {string }
-   */
-  assetReferenceType: string;
-
-  /**
-   * @constructor
-   */
-  constructor() {
-    this.metadata = new Map();
-    this.sources = new MediaSources();
-    this.type = MediaEntry.Type.UNKNOWN;
-  }
-
-  /**
-   * Convert class to native js object.
-   * @returns {ProviderMediaEntryObject} - The json class object.
-   */
-  toJSON(): ProviderMediaEntryObject {
-    return {
-      id: this.id,
-      name: this.name,
-      sources: this.sources.toJSON(),
-      duration: this.duration,
-      dvrStatus: this.dvrStatus,
-      status: this.status,
-      metadata: this.metadata,
-      type: this.type,
-      poster: this.poster,
-      assetReferenceType: this.assetReferenceType
-    };
-  }
-}

package/src/entities/media-format.js

@@ -1,46 +0,0 @@
-//@flow
-export const MediaFormat: {[name: string]: ProviderMediaFormatType} = {
-  DASH: {
-    name: 'dash',
-    mimeType: 'application/dash+xml',
-    pathExt: 'mpd'
-  },
-  HLS: {
-    name: 'hls',
-    mimeType: 'application/x-mpegURL',
-    pathExt: 'm3u8'
-  },
-  WVM: {
-    name: 'wvm',
-    mimeType: 'video/wvm',
-    pathExt: 'wvm'
-  },
-  MP4: {
-    name: 'mp4',
-    mimeType: 'video/mp4',
-    pathExt: 'mp4'
-  },
-  MP3: {
-    name: 'mp3',
-    mimeType: 'audio/mpeg',
-    pathExt: 'mp3'
-  }
-};
-
-export const SupportedStreamFormat: Map<string, ProviderMediaFormatType> = new Map([
-  ['mpegdash', MediaFormat.DASH],
-  ['applehttp', MediaFormat.HLS],
-  ['url', MediaFormat.MP4]
-]);
-
-/**
- * returns a boolean whether a source is progressive or not
- * @param {string} formatName - the format name
- * @returns {boolean} - if source is progressive or not
- */
-function isProgressiveSource(formatName: string): boolean {
-  const sourceFormat = SupportedStreamFormat.get(formatName);
-  return !!sourceFormat && sourceFormat.name === MediaFormat.MP4.name;
-}
-
-export {isProgressiveSource};

package/src/entities/media-source.js

@@ -1,70 +0,0 @@
-//@flow
-import Drm from './drm';
-
-export default class MediaSource {
-  /**
-   * @member - media source id
-   * @type {string}
-   */
-  id: string;
-  /**
-   * @member - media source url
-   * @type {string}
-   */
-  url: string;
-  /**
-   * @member - media source mimetype
-   * @type {string}
-   */
-  mimetype: string;
-  /**
-   * @member - media source drm data
-   * @type {Array<Drm>}
-   */
-  drmData: Array<Drm>;
-  /**
-   * @member - media source bandwidth
-   * @type {number}
-   */
-  bandwidth: number;
-  /**
-   * @member - media source width
-   * @type {number}
-   */
-  width: number;
-  /**
-   * @member - media source height
-   * @type {number}
-   */
-  height: number;
-  /**
-   * @member - media source label
-   * @type {string}
-   */
-  label: string;
-
-  /**
-   * Convert class to native js object.
-   * @returns {ProviderMediaSourceObject} - The json class object.
-   */
-  toJSON(): ProviderMediaSourceObject {
-    const response: ProviderMediaSourceObject = {
-      id: this.id,
-      url: this.url,
-      mimetype: this.mimetype
-    };
-    if (this.bandwidth) response.bandwidth = this.bandwidth;
-    if (this.width) response.width = this.width;
-    if (this.height) response.height = this.height;
-    if (this.label) response.label = this.label;
-    if (this.drmData && this.drmData.length > 0) {
-      response.drmData = [];
-      this.drmData.forEach(d => {
-        if (Array.isArray(response.drmData)) {
-          response.drmData.push(d.toJSON());
-        }
-      });
-    }
-    return response;
-  }
-}

package/src/entities/media-sources.js

@@ -1,79 +0,0 @@
-// @flow
-import MediaSource from './media-source';
-import {MediaFormat} from './media-format';
-import ImageSource from './image-source';
-
-export default class MediaSources {
-  /**
-   * Progressive download media sources container.
-   * @type {Array<MediaSource>}
-   * @public
-   */
-  progressive: Array<MediaSource>;
-  /**
-   * Dash media sources container.
-   * @type {Array<MediaSource>}
-   * @public
-   */
-  dash: Array<MediaSource>;
-  /**
-   * Hls media sources container.
-   * @type {Array<MediaSource>}
-   * @public
-   */
-  hls: Array<MediaSource>;
-  image: Array<ImageSource>;
-  captions: Array<PKExternalCaptionObject>;
-
-  /**
-   * @constructor
-   */
-  constructor() {
-    this.progressive = [];
-    this.dash = [];
-    this.hls = [];
-    this.image = [];
-  }
-
-  /**
-   * Maps the source to one of the containers according to his media format.
-   * @param {MediaSource} source - The source to add to one of the containers.
-   * @param {MediaFormat} mediaFormat - The media format of the source.
-   * @returns {void}
-   */
-  map(source: MediaSource, mediaFormat: ?ProviderMediaFormatType) {
-    if (mediaFormat) {
-      switch (mediaFormat.name) {
-        case MediaFormat.MP4.name:
-          this.progressive.push(source);
-          break;
-        case MediaFormat.DASH.name:
-          this.dash.push(source);
-          break;
-        case MediaFormat.HLS.name:
-          this.hls.push(source);
-          break;
-        default:
-          break;
-      }
-    }
-  }
-
-  /**
-   * Convert class to native js object.
-   * @returns {ProviderMediaSourcesObject} - The json class object.
-   */
-  toJSON(): ProviderMediaSourcesObject {
-    const response: ProviderMediaSourcesObject = {
-      progressive: [],
-      dash: [],
-      hls: [],
-      image: []
-    };
-    this.progressive.forEach(p => response.progressive.push(p.toJSON()));
-    this.hls.forEach(h => response.hls.push(h.toJSON()));
-    this.dash.forEach(d => response.dash.push(d.toJSON()));
-    response.image = this.image;
-    return response;
-  }
-}

package/src/entities/playlist.js

@@ -1,37 +0,0 @@
-//@flow
-
-import MediaEntry from '../entities/media-entry';
-
-export default class Playlist {
-  /**
-   * @member - playlist id
-   * @type {string}
-   */
-  id: string;
-  /**
-   * @member - playlist name
-   * @type {string}
-   */
-  name: string;
-  /**
-   * @member - playlist description
-   * @type {string}
-   */
-  description: string;
-
-  /**
-   * @member - playlist poster
-   * @type {string}
-   */
-  poster: string;
-
-  /**
-   * @member - playlist items
-   * @type {Array<MediaEntry>}
-   */
-  items: Array<MediaEntry>;
-
-  constructor() {
-    this.items = [];
-  }
-}

package/src/index.html

@@ -1,11 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <title>Title</title>
-</head>
-<body>
-<script>
-</script>
-</body>
-</html>

package/src/k-provider/common/base-provider.js

@@ -1,110 +0,0 @@
-// @flow
-import {getLogLevel, setLogLevel, setLogger, type LogLevelType, LogLevel} from '../../util/logger';
-import DataLoaderManager from './data-loader-manager';
-import Error from '../../util/error/error';
-
-export default class BaseProvider<MI> {
-  _partnerId: number;
-  _widgetId: ?string;
-  _ks: string;
-  _uiConfId: ?number;
-  _dataLoader: DataLoaderManager;
-  _playerVersion: string;
-  _logger: any;
-  _isAnonymous: boolean;
-  _networkRetryConfig: ProviderNetworkRetryParameters = {
-    async: true,
-    timeout: 0,
-    maxAttempts: 4
-  };
-
-  get partnerId(): number {
-    return this._partnerId;
-  }
-
-  get widgetId(): string {
-    return this._widgetId || this.defaultWidgetId;
-  }
-
-  get defaultWidgetId(): string {
-    return '_' + this._partnerId;
-  }
-
-  get uiConfId(): ?number {
-    return this._uiConfId;
-  }
-
-  get ks(): string {
-    return this._ks;
-  }
-
-  set ks(value: string): void {
-    this._ks = value;
-  }
-
-  get playerVersion(): string {
-    return this._playerVersion;
-  }
-
-  get isAnonymous(): boolean {
-    return this._isAnonymous;
-  }
-
-  constructor(options: ProviderOptionsObject, playerVersion: string) {
-    setLogger(options.logger);
-    this._partnerId = options.partnerId;
-    this._widgetId = options.widgetId;
-    this._uiConfId = options.uiConfId;
-    this._isAnonymous = !options.ks;
-    this._ks = options.ks || '';
-    this._playerVersion = playerVersion;
-  }
-
-  // eslint-disable-next-line no-unused-vars
-  getMediaConfig(mediaInfo: MI): Promise<ProviderMediaConfigObject> {
-    return Promise.reject(
-      new Error(Error.Severity.CRITICAL, Error.Category.PROVIDER, Error.Code.METHOD_NOT_IMPLEMENTED, {
-        message: 'getMediaConfig method must be implement by the derived class'
-      })
-    );
-  }
-
-  // eslint-disable-next-line no-unused-vars
-  getPlaylistConfig(playlistInfo: ProviderPlaylistInfoObject): Promise<ProviderPlaylistObject> {
-    return Promise.reject(
-      new Error(Error.Severity.CRITICAL, Error.Category.PROVIDER, Error.Code.METHOD_NOT_IMPLEMENTED, {
-        message: 'The provider does not support loading playlist by id'
-      })
-    );
-  }
-
-  // eslint-disable-next-line no-unused-vars
-  getEntryListConfig(entryListInfo: ProviderEntryListObject): Promise<ProviderPlaylistObject> {
-    return Promise.reject(
-      new Error(Error.Severity.CRITICAL, Error.Category.PROVIDER, Error.Code.METHOD_NOT_IMPLEMENTED, {
-        message: 'The provider does not support loading entry list'
-      })
-    );
-  }
-
-  _verifyHasSources(sources: ProviderMediaConfigSourcesObject) {
-    if (sources.hls.concat(sources.dash, sources.progressive, sources.image).length === 0) {
-      throw new Error(Error.Severity.CRITICAL, Error.Category.SERVICE, Error.Code.MISSING_PLAY_SOURCE, {
-        action: '',
-        messages: `No play source for entry id: ${sources.id}`
-      });
-    }
-  }
-
-  get LogLevel(): LogLevelType {
-    return LogLevel;
-  }
-
-  getLogLevel(name?: string): Object {
-    return getLogLevel(name);
-  }
-
-  setLogLevel(level: Object, name?: string): void {
-    setLogLevel(level, name);
-  }
-}

package/src/k-provider/common/base-service-result.js

@@ -1,57 +0,0 @@
-//@flow
-export default class ServiceResult {
-  /**
-   * @member - Is service returned an error
-   * @type {boolean}
-   */
-  hasError: boolean = false;
-  /**
-   * @member - The service error
-   * @type {ServiceError}
-   */
-  error: ServiceError;
-  /**
-   * @member - The service result data
-   * @type {Object}
-   */
-  data: Object;
-
-  /**
-   * @constructor
-   * @param {Object} response - Service response
-   */
-  constructor(response: Object) {
-    if (response.objectType === 'KalturaAPIException') {
-      this.hasError = true;
-      this.error = new ServiceError(response.code, response.message);
-    } else if (response.error && response.error.objectType === 'KalturaAPIException') {
-      this.hasError = true;
-      this.error = new ServiceError(response.error.code, response.error.message);
-    } else {
-      this.data = response;
-    }
-  }
-}
-
-class ServiceError {
-  /**
-   * @member - The error code
-   * @type {string}
-   */
-  code: string;
-  /**
-   * @member - The error message
-   * @type {string}
-   */
-  message: string;
-
-  /**
-   * @constructor
-   * @param {string} code - The result code
-   * @param {string} message - The result message
-   */
-  constructor(code: string, message: string) {
-    this.code = code;
-    this.message = message;
-  }
-}

package/src/k-provider/common/data-loader-manager.js

@@ -1,115 +0,0 @@
-// @flow
-import MultiRequestBuilder, {MultiRequestResult} from './multi-request-builder';
-import Error from '../../util/error/error';
-
-export default class DataLoaderManager {
-  /**
-   * @member - Loaders response map index
-   * @type {Map<string,Array<number>>}
-   * @private
-   */
-  _loadersResponseMap: Map<string, Array<number>> = new Map();
-  /**
-   * @member - Loaders multi request
-   * @type {MultiRequestBuilder}
-   * @protected
-   */
-  _multiRequest: MultiRequestBuilder;
-  /**
-   * @member - Loaders multi response
-   * @type {MultiRequestResult}
-   * @private
-   */
-  _multiResponse: MultiRequestResult;
-  /**
-   * @member - Loaders to execute
-   * @type {Map<string,Function>}
-   * @private
-   */
-  _loaders: Map<string, ILoader> = new Map();
-
-  _networkRetryConfig: ProviderNetworkRetryParameters;
-
-  constructor(networkRetryConfig: ProviderNetworkRetryParameters) {
-    this._networkRetryConfig = networkRetryConfig;
-  }
-
-  /**
-   * Add loader to execution loaders map
-   * @function
-   * @param {Function} loader Loader to add
-   * @param {Object} params Loader params
-   * @param {string} ks ks
-   * @returns {void}
-   */
-  add(loader: Function, params: Object, ks?: string): void {
-    let execution_loader = new loader(params);
-    if (execution_loader.isValid()) {
-      this._loaders.set(loader.id, execution_loader);
-      // Get the start index from the multiReqeust before adding current execution_loader requests
-      let startIndex = this._multiRequest.requests.length;
-      // Get the requests
-      let requests = execution_loader.requests;
-      this._multiRequest.retryConfig = this._networkRetryConfig;
-      // Add requests to multiRequest queue
-      requests.forEach(request => {
-        request.params = request.params || {};
-        request.params.ks = request.params.ks || ks;
-        this._multiRequest.add(request);
-      });
-      // Create range array of current execution_loader requests
-      let executionLoaderResponseMap = Array.from(new Array(requests.length), (val, index) => index + startIndex);
-      // Add to map
-      this._loadersResponseMap.set(loader.id, executionLoaderResponseMap);
-    }
-  }
-
-  /**
-   * Get data from all loaders using multi request
-   * @param {boolean} requestsMustSucceed whether all of the requests must succeed or not
-   * @function
-   * @returns {Promise} Promise
-   */
-  fetchData(requestsMustSucceed?: boolean): Promise<any> {
-    return new Promise((resolve, reject) => {
-      this._multiRequest.execute(requestsMustSucceed).then(
-        data => {
-          this._multiResponse = data.response;
-          let preparedData: Object = this.prepareData(data.response);
-          if (preparedData.success) {
-            resolve(this._loaders);
-          } else {
-            reject(
-              new Error(Error.Severity.CRITICAL, Error.Category.NETWORK, Error.Code.API_RESPONSE_MISMATCH, {
-                headers: data.headers
-              })
-            );
-          }
-        },
-        err => {
-          reject(err);
-        }
-      );
-    });
-  }
-
-  /**
-   * Prepare fetched data
-   * @function
-   * @param {MultiRequestResult} response - The multi request result
-   * @returns {Object} - The prepared data
-   */
-  prepareData(response: MultiRequestResult): Object {
-    this._loaders.forEach((loader, name) => {
-      let loaderDataIndexes = this._loadersResponseMap.get(name);
-      try {
-        if (loaderDataIndexes && loaderDataIndexes.length > 0) {
-          loader.response = response.results.slice(loaderDataIndexes[0], loaderDataIndexes[loaderDataIndexes.length - 1] + 1);
-        }
-      } catch (err) {
-        return {success: false, error: err};
-      }
-    });
-    return {success: true, data: this._loaders};
-  }
-}