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

package/analytics-service/package.json

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

package/bookmark-service/package.json

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

package/dist/analytics-service.d.ts

@@ -0,0 +1,160 @@
+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 OVPAnalyticsService extends OVPService {
+    /**
+     * Creates an instance of RequestBuilder for analytics.trackEvent
+     * @function trackEvent
+     * @param {string} serviceUrl - The service base url
+     * @param {Object} params - The event params
+     * @param {string} [requestMethod] - The request method GET or POST
+     * @returns {RequestBuilder} - The request builder
+     * @static
+     */
+    static trackEvent(serviceUrl: string, params: any, requestMethod?: string): RequestBuilder;
+    private static _trackEventByGET;
+    private static _trackEventByPOST;
+}
+
+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;
+}
+
+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/bookmark-service.d.ts

@@ -0,0 +1,157 @@
+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 OTTBookmarkService extends OTTService {
+    /**
+     * Creates an instance of RequestBuilder for session.startWidgetSession
+     * @function add
+     * @param {string} serviceUrl - The service url
+     * @param {string} ks - The ks
+     * @param {Object} bookmark - The udid
+     * @returns {RequestBuilder} - The request builder
+     * @static
+     */
+    static add(serviceUrl: string, ks: string, bookmark: any): RequestBuilder;
+}
+
+export declare class OTTConfiguration {
+    static set(clientConfig?: ProviderEnvConfigObject): void;
+    static get(): any;
+}
+
+declare class OTTService {
+    /**
+     * Gets a new instance of MultiRequestBuilder with ott params
+     * @function getMultiRequest
+     * @param {string} ks The ks
+     * @param {string} partnerId The partner ID
+     * @returns {MultiRequestBuilder} The multi request builder
+     * @static
+     */
+    static getMultiRequest(ks: string, partnerId?: number): MultiRequestBuilder;
+}
+
+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 { }