@vindral/web-sdk 2.0.23 → 2.0.26

package/index.d.ts

@@ -75,12 +75,13 @@ interface InitSegment {
 }
 declare type MatchingKeys<TRecord, TMatch, K extends keyof TRecord = keyof TRecord> = K extends (TRecord[K] extends TMatch ? K : never) ? K : never;
 declare type VoidKeys<Record> = MatchingKeys<Record, void>;
+declare type EventListenerReturnType = (() => void) | void;
 declare class Emitter<TEvents, TEmits = TEvents, ArgLessEvents extends VoidKeys<TEvents> = VoidKeys<TEvents>, ArgEvents extends Exclude<keyof TEvents, ArgLessEvents> = Exclude<keyof TEvents, ArgLessEvents>, ArgLessEmits extends VoidKeys<TEmits> = VoidKeys<TEmits>, ArgEmits extends Exclude<keyof TEmits, ArgLessEmits> = Exclude<keyof TEmits, ArgLessEmits>> {
 	private listeners;
 	emit<T extends ArgLessEmits>(eventName: T): void;
 	emit<T extends ArgEmits>(eventName: T, args: TEmits[T]): void;
-	off<T extends ArgLessEvents>(eventName: T, fn: () => void): void;
-	off<T extends ArgEvents>(eventName: T, fn: (args: TEvents[T]) => void): void;
+	off<T extends ArgLessEvents>(eventName: T, fn: () => EventListenerReturnType): void;
+	off<T extends ArgEvents>(eventName: T, fn: (args: TEvents[T]) => EventListenerReturnType): void;
 	on<T extends ArgLessEvents>(eventName: T, fn: () => void): void;
 	on<T extends ArgEvents>(eventName: T, fn: (args: TEvents[T]) => void): void;
 	once<T extends ArgLessEvents>(eventName: T, fn: () => void): void;
@@ -437,7 +438,7 @@ declare class BufferTimeModule {
 interface VindralErrorProps {
 	isFatal: boolean;
 	code: string;
-	source?: Error;
+	source?: Error | MediaError;
 }
 export declare const CONNECTION_FAILED_CODE = "connection_failed";
 export declare const CONNECTION_FAILED_AFTER_RETRIES_CODE = "connection_failed_will_not_attempt_again";
@@ -448,24 +449,26 @@ export declare const NO_INCOMING_DATA = "no_incoming_data_error";
 export declare const INACTIVITY_CODE = "connection_inactivity";
 export declare const MISSING_INIT_SEGMENT = "missing_init_segment";
 export declare const NO_TRACK_CONTEXT = "no_track_context";
+export declare const DISCONNECTED_BY_EDGE = "disconnected_by_edge";
 export declare class VindralError extends Error {
 	private props;
 	private extra;
 	constructor(message: string, props: VindralErrorProps, extra?: {});
 	code: () => string;
 	isFatal: () => boolean;
-	source: () => Error | undefined;
+	source: () => Error | MediaError | undefined;
 	toStringifiable: () => Record<string, unknown>;
 }
-export declare const mediaElementError: (isFatal: boolean, mediaError: MediaError) => VindralError;
+export declare const mediaElementError: (isFatal: boolean, source: MediaError) => VindralError;
 export declare const missingInitSegmentError: (renditionId: number, channelId: string) => VindralError;
 export declare const noTrackContextError: (type: "audio" | "video", renditionId: number, channelId: string) => VindralError;
 export declare const audioContextTimeoutError: () => VindralError;
-export declare const authenticationError: () => VindralError;
-export declare const authenticationExpiredError: () => VindralError;
-export declare const inactivityError: () => VindralError;
-export declare const channelNotFoundError: () => VindralError;
-export declare const noIncomingDataError: () => VindralError;
+export declare const disconnectedFromEdgeServerError: (source?: VindralError | undefined) => VindralError;
+export declare const authenticationError: (source?: Error | undefined) => VindralError;
+export declare const authenticationExpiredError: (source?: Error | undefined) => VindralError;
+export declare const inactivityError: (source?: Error | undefined) => VindralError;
+export declare const channelNotFoundError: (source?: Error | undefined) => VindralError;
+export declare const noIncomingDataError: (source?: Error | undefined) => VindralError;
 export declare const unableToConnectError: (source?: Error | undefined) => VindralError;
 export declare const unableToConnectAfterRetriesError: () => VindralError;
 declare type State = "connected" | "disconnected" | "connecting";
@@ -875,6 +878,7 @@ declare class MseModule {
 	private quotaErrorCount;
 	constructor(logger: Logger, emitter: Emitter<MseModuleListeners, MseModuleEvents>, mediaElement: HTMLMediaElement, tracks: Track[]);
 	static create: (logger: Logger, emitter: Emitter<MseModuleListeners, MseModuleEvents>, mediaElement: HTMLMediaElement, tracks: Track[]) => Promise<MseModule>;
+	load: () => void;
 	unload: () => void;
 	getStatistics: () => MseModuleStatistics;
 	private open;
@@ -1174,6 +1178,8 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	private apiClient;
 	private latestEmittedLanguages;
 	private wakeLock;
+	private cachedEdges;
+	private shiftedEdges;
 	private durationSessions;
 	constructor(options: Options);
 	attach: (container: HTMLElement) => void;
@@ -1242,6 +1248,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	private play;
 	get uptime(): number;
 	getStatistics: () => Statistics;
+	private getRuntimeInfo;
 	private onBufferEvent;
 	private alignSizeAndBitRate;
 	private get currentSubscription();
@@ -1257,7 +1264,13 @@ interface TelemetryModuleOptions {
 	includeStats?: boolean;
 	maxRetries?: number;
 	maxErrorReports?: number;
+	maxEvents?: number;
+}
+interface ShiftedEdgeEvent {
+	code: "shifted_edge";
+	edgeUrl: string;
 }
+declare type TelemetryEvent = ShiftedEdgeEvent;
 interface FlushOptions {
 	isFinal?: boolean;
 	initiator: StatsInitiator;
@@ -1279,16 +1292,19 @@ declare class TelemetryModule {
 	private timers;
 	private emitter;
 	private options;
+	private runtimeInfo;
 	private statisticsSource;
 	private unsentLines;
 	private retries;
 	private errorCount;
+	private eventCount;
 	private statsCount;
 	private constructor();
 	unload: () => void;
-	static create: (logger: Logger, emitter: Emitter<TelemetryModuleListeners, unknown>, options: TelemetryModuleOptions, statisticsSource: TelemetryStatisticsSource) => TelemetryModule;
+	static create: (logger: Logger, emitter: Emitter<TelemetryModuleListeners, unknown>, options: TelemetryModuleOptions, runtimeInfo: () => Record<string, unknown>, statisticsSource: TelemetryStatisticsSource) => TelemetryModule;
 	load: () => void;
 	addStats: ({ isFinal, initiator }?: FlushOptions, extra?: Record<string, unknown>) => void;
+	addEvent: (event: TelemetryEvent) => void;
 	getStatistics: () => TelemetryModuleStatistics;
 	private send;
 	private onVisibilityChange;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vindral/web-sdk",
-  "version": "2.0.23",
+  "version": "2.0.26",
   "homepage": "https://vindral.com",
   "description": "Web SDK for viewing Vindral streams",
   "license": "SEE LICENSE IN https://www.vindral.com/terms-conditions",