@playkit-js/playkit-js-providers 2.41.0-canary.0-bb5f4a7 → 2.41.0-canary.0-3d6d02a

package/package.json

@@ -1,36 +1,44 @@
 {
   "name": "@playkit-js/playkit-js-providers",
-  "version": "2.41.0-canary.0-bb5f4a7",
+  "version": "2.41.0-canary.0-3d6d02a",
   "description": "",
-  "types": "./dist/index.d.ts",
   "files": [
     "dist/**/*",
     "src/**/*",
     "flow-typed/**/*",
-    "playkit-analytics-service/*",
-    "playkit-bookmark-service/*",
-    "playkit-ott-provider/*",
-    "playkit-ovp-provider/*",
-    "playkit-stats-service/*"
+    "analytics-service/*",
+    "bookmark-service/*",
+    "ott-provider/*",
+    "ovp-provider/*",
+    "stats-service/*",
+    "types/*"
   ],
   "exports": {
-    "./playkit-ovp-provider": "./dist/playkit-ovp-provider.js",
-    "./playkit-ott-provider": "./dist/playkit-ott-provider.js",
-    "./playkit-analytics-service": "./dist/playkit-analytics-service.js",
-    "./playkit-stats-service": "./dist/playkit-stats-service.js",
-    "./playkit-bookmark-service": "./dist/playkit-bookmark-service.js"
+    "./ovp-provider": "./dist/playkit-ovp-provider.js",
+    "./ott-provider": "./dist/playkit-ott-provider.js",
+    "./analytics-service": "./dist/playkit-analytics-service.js",
+    "./stats-service": "./dist/playkit-stats-service.js",
+    "./bookmark-service": "./dist/playkit-bookmark-service.js",
+    "./types": "./dist/types.d.ts"
   },
   "scripts": {
     "serve": "webpack serve --open --mode=development",
     "build:dev": "webpack --mode=development",
     "build:prod": "webpack --mode=production --node-env=production",
     "build": "yarn run build:prod && yarn run build:types",
-    "build:types": "tsc --build tsconfig-lib.json && mkdir -p lib && api-extractor run --local",
+    "build:types": "yarn run build:types:ovp && yarn run build:types:ott && yarn run build:types:analytics && yarn run build:types:bookmark && yarn run build:types:stats && yarn run build:types:types",
+    "build:types:ovp": "tsc --build tsconfig-lib.json && mkdir -p lib && api-extractor run --config api-extracor-config/api-extractor-ovp-provider.json --local",
+    "build:types:ott": "tsc --build tsconfig-lib.json && mkdir -p lib && api-extractor run --config api-extracor-config/api-extractor-ott-provider.json --local",
+    "build:types:analytics": "tsc --build tsconfig-lib.json && mkdir -p lib && api-extractor run --config api-extracor-config/api-extractor-analytics-service.json --local",
+    "build:types:bookmark": "tsc --build tsconfig-lib.json && mkdir -p lib && api-extractor run --config api-extracor-config/api-extractor-bookmark-service.json --local",
+    "build:types:stats": "tsc --build tsconfig-lib.json && mkdir -p lib && api-extractor run --config api-extracor-config/api-extractor-stats-service.json --local",
+    "build:types:types": "tsc --build tsconfig-lib.json && mkdir -p lib && api-extractor run --config api-extracor-config/api-extractor-types.json --local",
     "type-check": "tsc --noEmit",
     "type-check:watch": "npm run type-check -- --watch",
     "watch": "webpack --mode=development --watch",
     "test": "NODE_ENV=test karma start --color --mode development",
     "test:watch": "NODE_ENV=test karma start --browsers=Chrome --single-run=false --auto-watch",
+    "test:debug": "NODE_ENV=test karma start --browsers=Chrome --single-run=false --auto-watch --debug",
     "release": "standard-version",
     "pushTaggedRelease": "git push --follow-tags --no-verify origin master",
     "lint": "eslint src/ --ext .js --ext .ts",
@@ -43,8 +51,8 @@
     "@babel/plugin-transform-runtime": "^7.22.15",
     "@babel/preset-env": "^7.21.5",
     "@babel/preset-typescript": "^7.22.15",
-    "@microsoft/api-extractor": "^7.38.0",
-    "@playkit-js/browserslist-config": "^1.0.8-canary.0-f5791c1",
+    "@microsoft/api-extractor": "^7.39.4",
+    "@playkit-js/browserslist-config": "1.0.8",
     "@typescript-eslint/eslint-plugin": "^6.7.2",
     "@typescript-eslint/parser": "^6.7.2",
     "babel-eslint": "^10.1.0",

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

@@ -1,7 +1,15 @@
 import {getLogLevel, setLogLevel, setLogger, LogLevelType, LogLevel} from '../../util/logger';
 import DataLoaderManager from './data-loader-manager';
 import Error from '../../util/error/error';
-import {ProviderEntryListObject, ProviderMediaConfigObject, ProviderPlaylistInfoObject, ProviderMediaConfigSourcesObject, ProviderNetworkRetryParameters, ProviderOptionsObject, ProviderPlaylistObject} from '../../types';
+import {
+  ProviderEntryListObject,
+  ProviderMediaConfigObject,
+  ProviderPlaylistInfoObject,
+  ProviderMediaConfigSourcesObject,
+  ProviderNetworkRetryParameters,
+  ProviderOptionsObject,
+  ProviderPlaylistObject
+} from '../../types';
 
 export default class BaseProvider<MI> {
   private _partnerId: number;
@@ -11,7 +19,9 @@ export default class BaseProvider<MI> {
   public _dataLoader!: DataLoaderManager;
   private _playerVersion: string;
   public _logger: any;
+  public _referrer?: string;
   protected _isAnonymous: boolean;
+
   public _networkRetryConfig: ProviderNetworkRetryParameters = {
     async: true,
     timeout: 0,
@@ -58,6 +68,7 @@ export default class BaseProvider<MI> {
     this._isAnonymous = !options.ks;
     this._ks = options.ks || '';
     this._playerVersion = playerVersion;
+    this._referrer = options.referrer;
   }
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -109,4 +120,4 @@ export default class BaseProvider<MI> {
   }
 }
 
-export {BaseProvider}
+export {BaseProvider};

package/src/k-provider/ovp/loaders/media-entry-loader.ts

@@ -9,9 +9,9 @@ import {KalturaMediaEntry} from '../response-types';
 import {ILoader} from '../../../types';
 
 type OVPMediaEntryLoaderResponse = {
-  entry: KalturaMediaEntry,
-  playBackContextResult: KalturaPlaybackContext,
-  metadataListResult: KalturaMetadataListResponse
+  entry: KalturaMediaEntry;
+  playBackContextResult: KalturaPlaybackContext;
+  metadataListResult: KalturaMetadataListResponse;
 };
 export type {OVPMediaEntryLoaderResponse};
 
@@ -68,7 +68,7 @@ export default class OVPMediaEntryLoader implements ILoader {
     requests.push(OVPBaseEntryService.list(config.serviceUrl, params.ks, params.entryId, params.redirectFromEntryId, params.referenceId));
     // Use the entry id from the request result to support loading by referenceId
     const serviceEntryId = params.ks === '{1:result:ks}' ? '{2:result:objects:0:id}' : '{1:result:objects:0:id}';
-    requests.push(OVPBaseEntryService.getPlaybackContext(config.serviceUrl, params.ks, serviceEntryId));
+    requests.push(OVPBaseEntryService.getPlaybackContext(config.serviceUrl, params.ks, serviceEntryId, params.referrer));
     requests.push(OVPMetadataService.list(config.serviceUrl, params.ks, serviceEntryId));
     return requests;
   }

package/src/k-provider/ovp/provider-parser.ts

@@ -45,7 +45,7 @@ class OVPProviderParser {
     const kalturaSources = playbackContext.sources;
 
     mediaEntry.sources = OVPProviderParser._getParsedSources(kalturaSources, ks, partnerId, uiConfId, entry, playbackContext);
-    OVPProviderParser._fillBaseData(mediaEntry, entry, metadataList);
+    OVPProviderParser._fillBaseData(mediaEntry, entry, metadataList, playbackContext);
     if (mediaEntry.type !== MediaEntry.Type.LIVE && OVPConfiguration.get().useApiCaptions && playbackContext.data.playbackCaptions) {
       mediaEntry.sources.captions = ExternalCaptionsBuilder.createConfig(playbackContext.data.playbackCaptions, ks);
     }
@@ -151,7 +151,7 @@ class OVPProviderParser {
     }
   }
 
-  private static _fillBaseData(mediaEntry: MediaEntry, entry: KalturaMediaEntry, metadataList?: KalturaMetadataListResponse): MediaEntry {
+  private static _fillBaseData(mediaEntry: MediaEntry, entry: KalturaMediaEntry, metadataList?: KalturaMetadataListResponse, playbackContext?: any): MediaEntry {
     mediaEntry.poster = entry.poster;
     mediaEntry.id = entry.id;
     mediaEntry.duration = entry.duration;
@@ -174,6 +174,16 @@ class OVPProviderParser {
       mediaEntry.dvrStatus = entry.dvrStatus;
     }
 
+    if (playbackContext &&
+      playbackContext.flavorAssets[0] &&
+      playbackContext.flavorAssets[0].width && playbackContext.flavorAssets[0].height) {
+
+      const {height, width} = playbackContext.flavorAssets[0];
+      mediaEntry.metadata.heightRatio = +Number(height / width).toFixed(2);
+    } else {
+      mediaEntry.metadata.heightRatio = 1.78;
+    }
+
     return mediaEntry;
   }
 

package/src/k-provider/ovp/provider.ts

@@ -18,8 +18,10 @@ import {
   ProviderFilterOptionsObject,
   ProviderMediaConfigObject,
   ProviderMediaConfigSourcesObject,
-  ProviderOptionsObject, ProviderPlaylistInfoObject,
-  ProviderPlaylistObject, RequestLoader
+  ProviderOptionsObject,
+  ProviderPlaylistInfoObject,
+  ProviderPlaylistObject,
+  RequestLoader
 } from '../../types';
 
 export default class OVPProvider extends BaseProvider<OVPProviderMediaInfoObject> {
@@ -65,7 +67,7 @@ export default class OVPProvider extends BaseProvider<OVPProviderMediaInfoObject
           this._dataLoader.add(OVPSessionLoader, {widgetId: this.widgetId});
         }
         const redirectFromEntryId = this._getEntryRedirectFilter(mediaInfo);
-        this._dataLoader.add(OVPMediaEntryLoader, {entryId, ks, redirectFromEntryId, referenceId});
+        this._dataLoader.add(OVPMediaEntryLoader, {entryId, ks, redirectFromEntryId, referenceId, referrer: this._referrer});
         return this._dataLoader.fetchData().then(
           response => {
             try {
@@ -85,7 +87,7 @@ export default class OVPProvider extends BaseProvider<OVPProviderMediaInfoObject
     });
   }
 
-  public doRequest(loaders: Array<RequestLoader>, ks?: string): Promise<any> {
+  public doRequest(loaders: Array<RequestLoader>, ks?: string, requestsMustSucceed?: boolean): Promise<any> {
     const theKs: string = ks || this.ks;
     const dataLoader = new OVPDataLoaderManager(this.playerVersion, this.partnerId, theKs, this._networkRetryConfig);
 
@@ -98,7 +100,7 @@ export default class OVPProvider extends BaseProvider<OVPProviderMediaInfoObject
         // @ts-ignore
         dataLoader.add(loaderRequest.loader, loaderRequest.params, theKs || '{1:result:ks}');
       });
-      return dataLoader.fetchData().then(
+      return dataLoader.fetchData(requestsMustSucceed).then(
         response => {
           try {
             resolve(response);

package/src/k-provider/ovp/regex-action-handler.ts

@@ -27,34 +27,39 @@ class RegexActionHandler {
   }
 
   /**
-   * Ping the ECDN url to check if alive
-   * @function _pingECDNUrl
+   * Ping the ECDN url and replace the host urls if needed
+   * @function _pingECDNAndReplaceHostUrls
+   * @param {ProviderMediaConfigObject} mediaConfig - The media config
    * @param {KalturaAccessControlModifyRequestHostRegexAction} regexAction - The regex action
    * @param {string} cdnUrl - The CDN url
-   * @returns {Promise<boolean>} - Whether the media config sources urls should be modified or not
+   * @returns {Promise<ProviderMediaConfigObject>} - The media config with old or modified urls
    * @static
    * @private
    */
-  private static async _isECDNUrlAlive(regexAction: KalturaAccessControlModifyRequestHostRegexAction, cdnUrl: string): Promise<boolean> {
-    const urlPing = cdnUrl + '/api_v3/service/system/action/ping/format/1';
-    const req = new XMLHttpRequest();
-    req.open('GET', urlPing);
-    req.timeout = regexAction.checkAliveTimeoutMs;
-    req.onreadystatechange = (): boolean => {
-      if (req.readyState === 4) {
-        if (req.status === 200) {
-          return true;
+  private static _pingECDNAndReplaceHostUrls(
+    mediaConfig: ProviderMediaConfigObject,
+    regexAction: KalturaAccessControlModifyRequestHostRegexAction,
+    cdnUrl: string
+  ): Promise<ProviderMediaConfigObject> {
+    return new Promise(resolve => {
+      const urlPing = cdnUrl + '/api_v3/service/system/action/ping/format/1';
+      const req = new XMLHttpRequest();
+      req.open('GET', urlPing);
+      req.timeout = regexAction.checkAliveTimeoutMs;
+      req.onreadystatechange = ():void => {
+        if (req.readyState === 4) {
+          if (req.status === 200) {
+            RegexActionHandler._replaceHostUrls(mediaConfig, regexAction);
+          }
+          resolve(mediaConfig);
         }
-        return false;
-      }
-      return false;
-    };
-    req.ontimeout = (): boolean => {
-      RegexActionHandler._logger.warn(`Got timeout while pinging the ECDN url. the ping url: ${urlPing}`);
-      return false;
-    };
-    req.send();
-    return false;
+      };
+      req.ontimeout = ():void => {
+        RegexActionHandler._logger.warn(`Got timeout while pinging the ECDN url. the ping url: ${urlPing}`);
+        resolve(mediaConfig);
+      };
+      req.send();
+    });
   }
 
   /**
@@ -62,31 +67,33 @@ class RegexActionHandler {
    * @function handleRegexAction
    * @param {ProviderMediaConfigObject} mediaConfig - The media config
    * @param {Map<string, Function>} rawResponse - The raw response data from backend
-   * @returns {Promise<ProviderMediaConfigObject>} - The media config with old or modified urls
+   * @returns {ProviderMediaConfigObject} - The media config with old or modified urls
    * @static
    */
-  public static async handleRegexAction(mediaConfig: ProviderMediaConfigObject, rawResponse: Map<string, ILoader>): Promise<ProviderMediaConfigObject> {
-    const cdnUrl = OVPConfiguration.get().cdnUrl;
-    const regexAction = RegexActionHandler._extractRegexActionFromData(rawResponse);
-    const regExp = RegexActionHandler._getRegExp(regexAction);
+  public static handleRegexAction(mediaConfig: ProviderMediaConfigObject, rawResponse: Map<string, ILoader>): Promise<ProviderMediaConfigObject> {
+    return new Promise(resolve => {
+      const cdnUrl = OVPConfiguration.get().cdnUrl;
+      const regexAction = RegexActionHandler._extractRegexActionFromData(rawResponse);
+      const regExp = RegexActionHandler._getRegExp(regexAction);
 
-    if (
-      cdnUrl &&
-      regexAction &&
-      regExp &&
-      cdnUrl.match(regExp) &&
-      // we need to make the replacement in all cases except for when the checkAliveTimeoutMs > 0 && the ping has failed
-      !(
-        regexAction.checkAliveTimeoutMs > 0 &&
-        !(await RegexActionHandler._isECDNUrlAlive(regexAction, cdnUrl.replace(regExp, regexAction.replacement)))
-      )
-    ) {
-      RegexActionHandler._replaceHostUrls(mediaConfig, regexAction);
-      return mediaConfig;
-    }
-
-    RegexActionHandler._logger.debug('exiting handleRegexAction - not applying regex action.');
-    return mediaConfig;
+      if(
+        cdnUrl &&
+         regexAction &&
+         regExp &&
+         cdnUrl.match(regExp)
+      ) {
+        if (regexAction.checkAliveTimeoutMs > 0) {
+          RegexActionHandler._logger.debug('executing ping request...');
+          RegexActionHandler._pingECDNAndReplaceHostUrls(mediaConfig, regexAction, cdnUrl.replace(regExp, regexAction.replacement)).then(resolve);
+        } else {
+          RegexActionHandler._replaceHostUrls(mediaConfig, regexAction);
+          resolve(mediaConfig);
+        }
+      } else {
+        RegexActionHandler._logger.debug('exiting handleRegexAction - not applying regex action.');
+        resolve(mediaConfig);
+      }
+    });
   }
 
   /**

package/src/k-provider/ovp/services/base-entry-service.ts

@@ -14,7 +14,7 @@ export default class OVPBaseEntryService extends OVPService {
    * @returns {RequestBuilder} The request builder
    * @static
    */
-  public static getPlaybackContext(serviceUrl: string, ks: string, serviceEntryId: string): RequestBuilder {
+  public static getPlaybackContext(serviceUrl: string, ks: string, serviceEntryId: string, referrer?: string): RequestBuilder {
     const headers: Map<string, string> = new Map();
     headers.set('Content-Type', 'application/json');
     const request = new RequestBuilder(headers);
@@ -23,7 +23,7 @@ export default class OVPBaseEntryService extends OVPService {
     request.method = 'POST';
     request.url = request.getUrl(serviceUrl);
     request.tag = 'baseEntry-getPlaybackContext';
-    const contextDataParams = {objectType: 'KalturaContextDataParams', flavorTags: 'all'};
+    const contextDataParams = {objectType: 'KalturaContextDataParams', flavorTags: 'all', referrer};
     request.params = {entryId: serviceEntryId, ks: ks, contextDataParams: contextDataParams};
     return request;
   }

package/src/types/index.ts

@@ -24,11 +24,3 @@ export * from './playlist-info'
 export * from './provider-options'
 export * from './request-loader'
 export * from './poster'
-
-export { ProviderParser, RequestBuilder, ResponseTypes} from '../k-provider/ovp'
-export { ContextType, MediaType} from '../k-provider/ott'
-import {BaseProvider} from '../k-provider/common/base-provider'
-import OTTProvider from '../k-provider/ott/provider'
-import OVPProvider from '../k-provider/ovp/provider'
-export {OTTProvider, OVPProvider, OTTProvider as Provider, BaseProvider}
-export type IProvider = OTTProvider | OVPProvider;

package/src/types/provider-options.ts

@@ -14,4 +14,5 @@ export type ProviderOptionsObject = {
   filterOptions?: ProviderFilterOptionsObject;
   ignoreServerConfig?: boolean;
   loadThumbnailWithKs?: boolean;
+  referrer?: string;
 };

package/stats-service/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@playkit-js/playkit-js-providers/stats-service",
+  "main": "../dist/playkit-stats-service.js",
+  "types": "../dist/stats-service.d.ts",
+  "sideEffects": false
+}

package/types/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "@playkit-js/playkit-js-providers/types",
+  "types": "../dist/types.d.ts",
+  "sideEffects": false
+}

package/dist/playkit-ovp-provider.js.LICENSE.txt

@@ -1 +0,0 @@
-/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

package/playkit-analytics-service/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "@playkit-js/playkit-js-providers/playkit-analytics-service",
-  "main": "../dist/playkit-analytics-service.js",
-  "sideEffects": false
-}

package/playkit-bookmark-service/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "@playkit-js/playkit-js-providers/playkit-bookmark-service",
-  "main": "../dist/playkit-bookmark-service.js",
-  "sideEffects": false
-}

package/playkit-ott-provider/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "@playkit-js/playkit-js-providers/playkit-ott-provider",
-  "main": "../dist/playkit-ott-provider.js",
-  "sideEffects": false
-}

package/playkit-ovp-provider/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "@playkit-js/playkit-js-providers/playkit-ovp-provider",
-  "main": "../dist/playkit-ovp-provider.js",
-  "sideEffects": false
-}

package/playkit-stats-service/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "@playkit-js/playkit-js-providers/playkit-stats-service",
-  "main": "../dist/playkit-stats-service.js",
-  "sideEffects": false
-}