@playkit-js/playkit-js-providers 2.40.3-canary.0-442924e → 2.40.4-canary.0-b3e5269

package/dist/stats-service.d.ts

@@ -0,0 +1,159 @@
+declare class MultiRequestBuilder extends RequestBuilder {
+    private static _logger;
+    /**
+     * @memberof - MultiRequestBuilder
+     * @type {Array<RequestBuilder>}
+     */
+    requests: Array<RequestBuilder>;
+    /**
+     * Adds request to requests array
+     * @function add
+     * @param {RequestBuilder} request The request
+     * @returns {MultiRequestBuilder} The multiRequest
+     */
+    add(request: RequestBuilder): MultiRequestBuilder;
+    /**
+     * Executes a multi request
+     * @function execute
+     * @param {boolean} requestsMustSucceed whether all of the requests must succeed or not
+     * @returns {Promise} The multirequest execution promise
+     */
+    execute(requestsMustSucceed?: boolean): Promise<any>;
+}
+
+export declare const NAME: string;
+
+export declare class OVPConfiguration {
+    static set(clientConfig?: ProviderEnvConfigObject): void;
+    static get(): any;
+}
+
+declare class OVPService {
+    /**
+     * Gets a new instance of MultiRequestBuilder with ovp params
+     * @function getMultiRequest
+     * @param {string} playerVersion The player version
+     * @param {string} ks The ks
+     * @param {string} partnerId The partner ID
+     * @returns {MultiRequestBuilder} The multi request builder
+     * @static
+     */
+    static getMultiRequest(playerVersion: string, ks: string, partnerId?: number): MultiRequestBuilder;
+}
+
+export declare class OVPStatsService extends OVPService {
+    /**
+     * Creates an instance of RequestBuilder for stats.collect
+     * @function collect
+     * @param {string} serviceUrl - The service base url
+     * @param {string} ks - The ks
+     * @param {string} playerVersion - The player version
+     * @param {Object} event - The event data
+     * @returns {RequestBuilder} - The request builder
+     * @static
+     */
+    static collect(serviceUrl: string, ks: string, playerVersion: string, event: any): RequestBuilder;
+}
+
+declare type ProviderEnvConfigObject = {
+    serviceUrl: string;
+    cdnUrl?: string;
+    analyticsServiceUrl?: string;
+    useApiCaptions?: boolean;
+    replaceHostOnlyManifestUrls?: boolean;
+};
+
+declare type ProviderNetworkRetryParameters = {
+    async: boolean;
+    timeout?: number;
+    maxAttempts?: number;
+};
+
+export 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 const VERSION: string;
+
+export { }

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.38.5"
+      "packageVersion": "7.39.4"
     }
   ]
 }

package/dist/types.d.ts

@@ -0,0 +1,390 @@
+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;
+};
+
+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

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

package/ovp-provider/package.json

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

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@playkit-js/playkit-js-providers",
-  "version": "2.40.3-canary.0-442924e",
+  "version": "2.40.4-canary.0-b3e5269",
   "description": "",
-  "types": "./dist/index.d.ts",
   "files": [
     "dist/**/*",
     "src/**/*",
@@ -11,21 +10,29 @@
     "bookmark-service/*",
     "ott-provider/*",
     "ovp-provider/*",
-    "stats-service/*"
+    "stats-service/*",
+    "types/*"
   ],
   "exports": {
     "./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"
+    "./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",
@@ -43,8 +50,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/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/stats-service/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@playkit-js/playkit-js-providers/stats-service",
   "main": "../dist/playkit-stats-service.js",
-  "types": "../dist/index.d.ts",
+  "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
+}