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

package/dist/types.d.ts

@@ -0,0 +1,391 @@
+export declare type AdapterDataConfig = {
+    [key: string]: {
+        value: string;
+        objectType?: string;
+    };
+};
+
+export declare type CaptionType = {
+    [type: string]: string;
+};
+
+declare class DocumentSource {
+    /**
+     * @member - media source id
+     * @type {string}
+     */
+    id: string;
+    /**
+     * @member - media source url
+     * @type {string}
+     */
+    url: string;
+    /**
+     * @member - thumbnail url
+     * @type {string}
+     */
+    thumbnailUrl: string;
+    /**
+     * @member - media source mimetype
+     * @type {string}
+     */
+    mimetype: string;
+    constructor(entry: any);
+}
+
+export declare interface ILoader {
+    requests: Array<RequestBuilder>;
+    response: any;
+    isValid(): boolean;
+}
+
+declare class ImageSource {
+    /**
+     * @member - media source id
+     * @type {string}
+     */
+    id: string;
+    /**
+     * @member - media source url
+     * @type {string}
+     */
+    url: string;
+    /**
+     * @member - media source mimetype
+     * @type {string}
+     */
+    mimetype: string;
+    constructor(entry: any);
+    /**
+     * Extract the base thumbnail url.
+     * @param {string} url - dataUrl.
+     * @returns {string} - The base thumbnail url.
+     */
+    static extractBaseThumbnailUrl(url: string): string;
+}
+
+declare type loggerFunctionType = {
+    VERSION: string;
+    DEBUG: LogLevelObject;
+    ERROR: LogLevelObject;
+    INFO: LogLevelObject;
+    OFF: LogLevelObject;
+    TIME: LogLevelObject;
+    TRACE: LogLevelObject;
+    WARN: LogLevelObject;
+    createDefaultHandler: () => any;
+    debug: () => any;
+    enabledFor: () => any;
+    error: () => any;
+    get: () => any;
+    getLevel: () => any;
+    info: () => any;
+    log: () => any;
+    setHandler: () => any;
+    setLevel: () => any;
+    time: () => any;
+    timeEnd: () => any;
+    trace: () => any;
+    useDefaults: () => any;
+    warn: () => any;
+};
+
+declare type LoggerType = {
+    getLogger: loggerFunctionType;
+    LogLevel: LogLevelType;
+};
+
+declare type LogLevelObject = {
+    value: number;
+    name: string;
+};
+
+declare type LogLevelType = {
+    [level: string]: LogLevelObject;
+};
+
+export declare type OTTProviderMediaInfoObject = OVPProviderMediaInfoObject & {
+    mediaType: string;
+    contextType: string;
+    protocol?: string;
+    fileIds?: string;
+    streamerType?: string;
+    urlType?: string;
+    adapterData?: AdapterDataConfig;
+    assetReferenceType?: string;
+    formats?: Array<string>;
+};
+
+export declare type OVPProviderMediaInfoObject = {
+    entryId?: string;
+    referenceId?: string;
+    ks?: string;
+};
+
+export declare type PKExternalCaptionObject = {
+    url: string;
+    label: string;
+    language: string;
+    default?: boolean;
+    type?: string;
+};
+
+export declare interface Poster {
+    width: number;
+    height: number;
+    url: string;
+}
+
+export declare type ProviderDrmDataObject = {
+    licenseUrl: string;
+    scheme: string;
+    certificate?: string;
+};
+
+export declare type ProviderEntryListObject = {
+    entries: Array<ProviderMediaInfoObject>;
+    ks?: string;
+};
+
+export declare type ProviderEnvConfigObject = {
+    serviceUrl: string;
+    cdnUrl?: string;
+    analyticsServiceUrl?: string;
+    useApiCaptions?: boolean;
+    replaceHostOnlyManifestUrls?: boolean;
+};
+
+export declare type ProviderFilterOptionsObject = {
+    redirectFromEntryId?: boolean;
+};
+
+export declare type ProviderMediaConfigMetadataObject = {
+    name: string;
+    description?: string;
+    mediaType?: string;
+    contextType?: string;
+    metas?: any;
+    tags?: any;
+    epgId?: string;
+    recordingId?: string;
+    updatedAt?: number;
+    creatorId?: string;
+    views?: number;
+};
+
+export declare type ProviderMediaConfigObject = {
+    session: ProviderMediaConfigSessionObject;
+    sources: ProviderMediaConfigSourcesObject;
+    plugins: {
+        [plugin: string]: any;
+    };
+};
+
+export declare type ProviderMediaConfigSessionObject = {
+    partnerId: number;
+    uiConfId?: number;
+    ks?: string;
+    isAnonymous?: boolean;
+};
+
+export declare type ProviderMediaConfigSourcesObject = {
+    dash: Array<ProviderMediaSourceObject>;
+    hls: Array<ProviderMediaSourceObject>;
+    progressive: Array<ProviderMediaSourceObject>;
+    image: Array<ImageSource>;
+    document: Array<DocumentSource>;
+    duration?: number;
+    type: string;
+    id?: string;
+    poster?: string | Array<any>;
+    dvr: boolean;
+    vr?: any;
+    metadata: ProviderMediaConfigMetadataObject;
+    captions?: Array<PKExternalCaptionObject>;
+    downloadUrl?: string;
+};
+
+export declare type ProviderMediaEntryObject = {
+    id?: string;
+    name?: string;
+    sources: ProviderMediaSourcesObject;
+    duration?: number;
+    dvrStatus?: number;
+    status?: number;
+    metadata: any;
+    type: string;
+    poster?: string | Poster[];
+    downloadUrl?: string;
+    assetReferenceType?: string;
+};
+
+export declare type ProviderMediaFormatType = {
+    name: string;
+    mimeType: string;
+    pathExt: string;
+};
+
+export declare type ProviderMediaInfoObject = OVPProviderMediaInfoObject | OTTProviderMediaInfoObject;
+
+export declare type ProviderMediaSourceObject = {
+    id: string;
+    url: string;
+    mimetype: string;
+    bandwidth?: number;
+    width?: number;
+    height?: number;
+    label?: string;
+    drmData?: Array<ProviderDrmDataObject>;
+};
+
+export declare type ProviderMediaSourcesObject = {
+    progressive: Array<ProviderMediaSourceObject>;
+    dash: Array<ProviderMediaSourceObject>;
+    hls: Array<ProviderMediaSourceObject>;
+    image: Array<ImageSource>;
+    document: Array<DocumentSource>;
+    captions?: Array<PKExternalCaptionObject>;
+};
+
+export declare type ProviderNetworkRetryParameters = {
+    async: boolean;
+    timeout?: number;
+    maxAttempts?: number;
+};
+
+export declare type ProviderOptionsObject = {
+    partnerId: number;
+    widgetId?: string;
+    logger?: LoggerType;
+    ks?: string;
+    uiConfId?: number;
+    env?: ProviderEnvConfigObject;
+    networkRetryParameters?: ProviderNetworkRetryParameters;
+    filterOptions?: ProviderFilterOptionsObject;
+    ignoreServerConfig?: boolean;
+    loadThumbnailWithKs?: boolean;
+    referrer?: string;
+};
+
+export declare type ProviderPlaybackContextOptions = {
+    mediaProtocol?: string;
+    assetFileIds?: string;
+    context?: string;
+    streamerType?: string;
+    urlType?: string;
+    adapterData?: AdapterDataConfig;
+};
+
+export declare type ProviderPlaylistInfoObject = {
+    playlistId: string;
+    ks?: string;
+};
+
+declare type ProviderPlaylistItemObject = {
+    sources: ProviderMediaConfigSourcesObject;
+};
+
+export declare type ProviderPlaylistMetadataObject = {
+    name: string;
+    description: string;
+};
+
+export declare type ProviderPlaylistObject = {
+    id: string;
+    metadata: ProviderPlaylistMetadataObject;
+    poster: string;
+    items: Array<ProviderPlaylistItemObject>;
+    playlistLastEntryId?: string;
+};
+
+declare class RequestBuilder {
+    /**
+     * @member - Service name
+     * @type {string}
+     */
+    service: string;
+    /**
+     * @member - Service action
+     * @type {string}
+     */
+    action: string;
+    /**
+     * @member - Service params
+     * @type {any}
+     */
+    params: any;
+    /**
+     * @memberof - Service headers
+     * @type {Map<string, string>}
+     */
+    headers: Map<string, string>;
+    /**
+     * @memberof - Service URL
+     * @type {string}
+     */
+    url: string;
+    /**
+     * @memberof - Service method (POST,GET,DELETE etc..)
+     * @type {string}
+     */
+    method: string;
+    /**
+     * @memberof - Service tag
+     * @type {string}
+     */
+    tag: string;
+    /**
+     * @memberof - the response headers of the arra
+     * @type {Array<string>}
+     */
+    responseHeaders: Array<string>;
+    /**
+     * @description network retry configuration
+     * @memberof RequestBuilder
+     * @type {ProviderNetworkRetryParameters}
+     */
+    retryConfig: ProviderNetworkRetryParameters;
+    /**
+     * @description number of xhr attempts for the same multi - request.
+     * @memberof RequestBuilder
+     * @type {number}
+     * @private
+     */
+    private _attemptCounter;
+    /**
+     * @description hold the promise result of the XHR request(s) - if all tries fails, it rejects with the error.
+     * @memberof RequestBuilder
+     * @type {Object}
+     * @private
+     */
+    private _requestPromise;
+    /**
+     * @constructor
+     * @param {Map<string, string>} headers The request headers
+     */
+    constructor(headers?: Map<string, string>);
+    /**
+     * Builds restful service URL
+     * @function getUrl
+     * @param {string} serviceUrl - The service base URL
+     * @returns {string} The service URL
+     */
+    getUrl(serviceUrl: string): string;
+    /**
+     * Executes service
+     * @function doHttpRequest
+     * @returns {Promise.<any>} Service response as promise
+     */
+    doHttpRequest(): Promise<any>;
+    private _createXHR;
+    private _getResponseHeaders;
+    private _handleError;
+    private _createError;
+}
+
+export declare type RequestLoader = {
+    loader: ILoader;
+    params: any;
+};
+
+export { }

package/ott-provider/package.json

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

package/ovp-provider/package.json

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

package/package.json

@@ -1,36 +1,44 @@
 {
   "name": "@playkit-js/playkit-js-providers",
-  "version": "2.41.0-canary.0-2452bbc",
+  "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",
@@ -38,19 +46,19 @@
     "prettier:fix": "prettier --write ."
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.38.0",
     "@babel/cli": "^7.10.1",
     "@babel/core": "^7.21.8",
-    "@babel/preset-typescript": "^7.22.15",
-    "typescript": "^5.2.2",
     "@babel/plugin-transform-runtime": "^7.22.15",
     "@babel/preset-env": "^7.21.5",
+    "@babel/preset-typescript": "^7.22.15",
+    "@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",
     "babel-loader": "^9.1.2",
     "chai": "^4.2.0",
     "eslint": "8.22.0",
-    "@typescript-eslint/eslint-plugin": "^6.7.2",
-    "@typescript-eslint/parser": "^6.7.2",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-import": "^2.22.0",
     "eslint-plugin-mocha-no-only": "^1.1.0",
@@ -60,7 +68,7 @@
     "karma-chrome-launcher": "^3.1.0",
     "karma-cli": "^2.0.0",
     "karma-coverage": "^2.0.2",
-    "karma-firefox-launcher": "^1.3.0",
+    "karma-firefox-launcher": "^2.1.2",
     "karma-ie-launcher": "^1.0.0",
     "karma-mocha": "^2.0.1",
     "karma-mocha-reporter": "^2.2.5",
@@ -74,10 +82,10 @@
     "sinon": "^9.0.2",
     "sinon-chai": "^3.5.0",
     "standard-version": "^6.0.1",
+    "typescript": "^5.2.2",
     "webpack": "^5.83.1",
     "webpack-cli": "^5.1.1",
-    "webpack-dev-server": "^4.15.0",
-    "@playkit-js/browserslist-config": "^1.0.5"
+    "webpack-dev-server": "^4.15.0"
   },
   "browserslist": [
     "extends @playkit-js/browserslist-config"

package/src/entities/document-source.ts

@@ -0,0 +1,31 @@
+export default class DocumentSource {
+  /**
+   * @member - media source id
+   * @type {string}
+   */
+  public id: string;
+  /**
+   * @member - media source url
+   * @type {string}
+   */
+  public url: string;
+  /**
+   * @member - thumbnail url
+   * @type {string}
+   */
+  public thumbnailUrl: string;
+  /**
+   * @member - media source mimetype
+   * @type {string}
+   */
+  public mimetype: string;
+
+  constructor(entry: any) {
+    this.id = entry.id;
+    this.url = entry.downloadUrl;
+    this.thumbnailUrl = entry.poster;
+    this.mimetype = '';
+  }
+}
+
+export {DocumentSource}

package/src/entities/media-entry.ts

@@ -8,7 +8,8 @@ export default class MediaEntry {
     LIVE: 'Live',
     IMAGE: 'Image',
     AUDIO: 'Audio',
-    UNKNOWN: 'Unknown'
+    UNKNOWN: 'Unknown',
+    DOCUMENT: 'Document'
   };
   public static DvrStatus: {[type: string]: number} = {
     ON: 1,

package/src/entities/media-sources.ts

@@ -1,6 +1,7 @@
 import MediaSource from './media-source';
 import {MediaFormat} from './media-format';
 import {ImageSource} from './image-source';
+import {DocumentSource} from './document-source';
 import {PKExternalCaptionObject, ProviderMediaFormatType, ProviderMediaSourcesObject} from '../types';
 
 export default class MediaSources {
@@ -23,6 +24,7 @@ export default class MediaSources {
    */
   public hls: Array<MediaSource>;
   public image: Array<ImageSource>;
+  public document: Array<DocumentSource>;
   public captions?: Array<PKExternalCaptionObject>;
 
   /**
@@ -33,6 +35,7 @@ export default class MediaSources {
     this.dash = [];
     this.hls = [];
     this.image = [];
+    this.document = [];
   }
 
   /**
@@ -68,12 +71,14 @@ export default class MediaSources {
       progressive: [],
       dash: [],
       hls: [],
-      image: []
+      image: [],
+      document: []
     };
     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;
+    response.document = this.document;
     return response;
   }
 }

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
@@ -88,7 +99,7 @@ export default class BaseProvider<MI> {
   }
 
   protected _verifyHasSources(sources: ProviderMediaConfigSourcesObject): void {
-    if (sources.hls.concat(sources.dash, sources.progressive, sources.image).length === 0) {
+    if (sources.hls.concat(sources.dash, sources.progressive, sources.image, sources.document).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}`
@@ -109,4 +120,4 @@ export default class BaseProvider<MI> {
   }
 }
 
-export {BaseProvider}
+export {BaseProvider};

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

@@ -213,6 +213,7 @@ export default class OTTProvider extends BaseProvider<OTTProviderMediaInfoObject
       dash: [],
       progressive: [],
       image: [],
+      document: [],
       id: '',
       duration: 0,
       type: MediaEntry.Type.UNKNOWN,

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;
   }