@tivio/sdk-js 2.0.0-alpha3 → 2.2.0

package/README.md

@@ -12,14 +12,28 @@ yarn add @tivio/sdk-js
 
 # Changelog
 
-* 2.0.0-alpha2
-  * add fetch polyfill
-  * requires core-js at least 1.12.0
-  * force using cloud fn instead of resolver
-  * major: rename positionMs to startFromPosition
-  * minor: add streamStart to TvProgramSource
-  * minor: add continueFromPosition to TvProgramSource, TivioVodSource, OtherSource and LiveTvChannelSource
-  * minor: live_tv_channel source type does pass-through instead of stopping the setSource action
+* 2.2.0
+  * minor: add `getProgramTimestamps`
+  * minor: add `addEventListener('markers', ...)` to player wrapper
+  * minor: add optional `calibrationId` parameter to `setSource`
+* 2.1.0
+  * minor: better es5 polyfills
+  * patch: add `verbose` to Tivio config type
+  * patch: add `bundleUrlOverride` to Tivio config type
+  * patch: fix of registering player wrapper when `createPlayerWrapper` is called after tivio init
+* 2.0.0
+  * requires core-js at least 1.13.0
+  * major: remove `createPlayerWrapper` from Tivio API object
+  * major: rename `positionMs` to `startFromPosition`
+  * minor: add `createPlayerWrapper` to the root of the @tivio-sdk-js package, it's not necessary to wait until
+    `createTivio` is finished before using it but it is still necessary to call `createTivio` at some point
+  * minor: add (optional) `capabilitiesOptions` and `deviceCapabilities` options to Tivio config
+  * minor: add fetch polyfill
+  * minor: better source types documentation
+  * minor: add `streamStart` to `TvProgramSource`
+  * minor: add `continueFromPosition` to `TvProgramSource`, `TivioVodSource`, `OtherSource` and `LiveTvChannelSource`
+  * minor: `live_tv_channel` source type does pass-through instead of stopping the `setSource` action
+  * minor: add `forceCloudFnResolver` option to Tivio config
 * 1.1.0
   * minor: fallback to fetch bundle by cloud fn when indexedDB not supported
   * minor: transpile to es5

package/dist/api.types.d.ts

@@ -134,17 +134,38 @@ declare type AdMetadata = {
     totalCount: number | null;
     skip: () => void;
 } | null;
+interface Marker {
+    id: string;
+    from: Date;
+    to: Date;
+    relativeFromMs: number;
+    relativeToMs: number;
+    type: 'AD' | 'AD_SEGMENT' | 'START' | 'END' | 'INTRO';
+}
 declare enum PlayerWrapperEventType {
-    adMetadata = "adMetadata"
+    adMetadata = "adMetadata",
+    markers = "markers"
 }
-declare type TivioPlayerWrapper = {
-    addEventListener: (eventType: PlayerWrapperEventType.adMetadata, listener: (metadata: AdMetadata) => void) => void;
+declare type PlayerWrapperEventTypeType = `${PlayerWrapperEventType}`;
+declare type ListenerAdMetadata = (metadata: AdMetadata) => void;
+declare type ListenerMarkers = (marker: Marker[] | null) => void;
+declare type Listener = ListenerAdMetadata | ListenerMarkers;
+interface TivioPlayerWrapper {
+    addEventListener: (eventType: PlayerWrapperEventTypeType, listener: Listener) => void;
     reportError: (error: Error) => void;
     reportPlaybackEnded: () => void;
     reportTimeProgress: (ms: number) => void;
     seekTo: (ms: number) => void;
     setSource: (source: Source | null) => void;
-};
+}
+interface PlayerInterfaceForPlayerWrapper {
+    /**
+     * @param {number} ms - milliseconds relative to start of video (relative to 0 ms)
+     *  or in case of TV programs relative to start of the program (relative to source.from ms)
+     */
+    seekTo: (ms: number) => void;
+    setSource: (source: Source | null) => void;
+}
 declare type ExposedApi = {
     AdSource: any;
     ChannelSource: any;
@@ -269,9 +290,10 @@ declare type ExposedApi = {
      * @param password
      */
     signInWithEmailAndPassword: (email: string, password: string) => Promise<void>;
-    createPlayerWrapper: (playerImplementation: {
-        setSource: (source: Source | null) => void;
-        seekTo: (ms: number) => void;
-    }) => TivioPlayerWrapper;
+    createPlayerWrapper: (playerImplementation: PlayerInterfaceForPlayerWrapper) => TivioPlayerWrapper;
+    getProgramTimestamps: (channelName: string, epgFrom: Date, epgTo: Date) => Promise<{
+        startTimestamp?: number;
+        endTimestamp?: number;
+    } | null>;
 };
-export { AdMetadata, AdSource, ExposedApi, LiveTvChannelSource, OtherSource, PlayerWrapperEventType, Source, TivioPlayerWrapper, TivioVodSource, TvProgramSource, };
+export type { AdMetadata, AdSource, ExposedApi, LiveTvChannelSource, OtherSource, PlayerInterfaceForPlayerWrapper, PlayerWrapperEventType, PlayerWrapperEventTypeType, Source, TivioPlayerWrapper, TivioVodSource, TvProgramSource, Marker, ListenerAdMetadata, ListenerMarkers, Listener, };

package/dist/conf.d.ts

@@ -5,7 +5,32 @@
 import { Logger } from './services/logger';
 import { FetchPackage } from './services/packageLoader';
 import { Conf as ExternalConf } from './types';
+export interface PlayerCapability {
+    codec: 'h264' | 'h265';
+    encryption: 'fairplay' | 'none' | 'playready' | 'widevine';
+    protocol: 'dash' | 'hls';
+}
 export declare type InternalConf = {
+    /**
+     * @private URL of remote code bundle to be fetched directly (without using resolver)
+     */
+    bundleUrlOverride?: string;
+    /**
+     * Tells Tivio which technologies/protocols etc. is the device capable to play.
+     * If not provided, Tivio will try to guess it (based on the browser).
+     */
+    deviceCapabilities?: PlayerCapability[];
+    /**
+     * Additional options for deviceCapabilities
+     */
+    capabilitiesOptions?: {
+        /**
+         * Should the player prefer HTTP sources instead HTTPs if they are available.
+         * This can be used on platforms that support mixed content but do not support
+         * specific HTTPS certificates. (e.g. certificates from Letsencrypt not supported on LG TVs)
+         */
+        preferHttp?: boolean;
+    };
     secret: string;
     resolverUrl: string;
     logger?: Logger | null;
@@ -13,9 +38,19 @@ export declare type InternalConf = {
     language?: string;
     sdkVersion: string;
     /**
-     * Defaults to true
+     * Can force using bundle resolver method which doesn't depend on indexedDB (useful when some polyfill
+     * for indexedDB is used but indexedDB is not fully supported - it leads to situation where check for indexedDB
+     * presence passes but resolver fails anyway).
+     */
+    forceCloudFnResolver?: boolean;
+    /**
+     * Can turn off Tivio's Sentry logging, defaults to true.
      */
     enableSentry?: boolean;
+    /**
+     * Can turn on Tivio's console logging, defaults to false.
+     */
+    verbose?: boolean;
 };
 export declare const defaultConf: {
     resolverUrl: string;

package/dist/index.d.ts

@@ -1,4 +1,7 @@
 import 'whatwg-fetch';
+import 'core-js/actual';
 export * from './services/bundleLoader';
+export * from './services/getProgramTimestamps';
 export * from './types';
 export * from './api.types';
+export { createPlayerWrapper } from './services/playerWrapper';