@oddin-gg/havik-player 1.14.0 → 1.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -164,6 +164,16 @@ export declare interface CreatePlayerOptions {
164
164
  * differs from that convention.
165
165
  */
166
166
  eventsBaseUrl?: string;
167
+ /**
168
+ * Extra headers attached to every request the SDK makes to {@link baseUrl}
169
+ * (playback resolution, live-status polling) — and ONLY there: never to
170
+ * CDN manifest/segment hosts, DRM license endpoints, the SSE events host,
171
+ * or the beacons endpoint. For integrations whose API front door wants
172
+ * its own auth signal on top of the publishable key — an operator console
173
+ * proving a session to its reverse proxy, or a customer gateway in front
174
+ * of the streams API. `x-api-key` cannot be overridden through this map.
175
+ */
176
+ apiHeaders?: Record<string, string>;
167
177
  /**
168
178
  * QoE beacons + CMCD session attribution. Active only when the playback
169
179
  * response carries an analytics sid (the server-side flag) — without one
@@ -295,6 +305,11 @@ export declare interface FetchCatalogOptions {
295
305
  etag?: string;
296
306
  status?: MatchLiveStatus | MatchLiveStatus[];
297
307
  sport?: string;
308
+ /**
309
+ * Extra headers attached to every request to {@link baseUrl} — and only
310
+ * there: never to CDN or license hosts. `x-api-key` cannot be overridden.
311
+ */
312
+ apiHeaders?: Record<string, string>;
298
313
  }
299
314
 
300
315
  /**
@@ -315,6 +330,11 @@ export declare interface FetchTournamentOptions {
315
330
  signal?: AbortSignal;
316
331
  /** Prior ETag for a conditional GET (304 when unchanged) — only effective once havik-streams ETags `/v1/tournaments/{urn}` (parity with `/v1/matches/{urn}`). */
317
332
  etag?: string;
333
+ /**
334
+ * Extra headers attached to every request to {@link baseUrl} — and only
335
+ * there: never to CDN or license hosts. `x-api-key` cannot be overridden.
336
+ */
337
+ apiHeaders?: Record<string, string>;
318
338
  }
319
339
 
320
340
  /** Flatten a Catalog to a single match list (handy for grids). */
@@ -687,6 +707,14 @@ export declare interface ResolveOptions {
687
707
  */
688
708
  waitForLive?: WaitForLive;
689
709
  signal?: AbortSignal;
710
+ /**
711
+ * Extra headers attached to every request this call makes to {@link baseUrl}
712
+ * — and ONLY there: never to CDN manifest/segment hosts or DRM license
713
+ * endpoints. For integrations whose API front door wants its own auth
714
+ * signal on top of the publishable key (gateways, operator consoles).
715
+ * `x-api-key` cannot be overridden.
716
+ */
717
+ apiHeaders?: Record<string, string>;
690
718
  }
691
719
 
692
720
  /**
@@ -870,6 +898,11 @@ export declare interface WatchStatusOptions {
870
898
  onError?: (err: PlaybackError) => void;
871
899
  /** Poll interval in ms. Floored at 2000. Default: 10000 (catalog max-age). */
872
900
  intervalMs?: number;
901
+ /**
902
+ * Extra headers attached to every request to {@link baseUrl} — and only
903
+ * there: never to CDN or license hosts. `x-api-key` cannot be overridden.
904
+ */
905
+ apiHeaders?: Record<string, string>;
873
906
  }
874
907
 
875
908
  export declare interface WidevineInfo {
package/dist/index.d.ts CHANGED
@@ -164,6 +164,16 @@ export declare interface CreatePlayerOptions {
164
164
  * differs from that convention.
165
165
  */
166
166
  eventsBaseUrl?: string;
167
+ /**
168
+ * Extra headers attached to every request the SDK makes to {@link baseUrl}
169
+ * (playback resolution, live-status polling) — and ONLY there: never to
170
+ * CDN manifest/segment hosts, DRM license endpoints, the SSE events host,
171
+ * or the beacons endpoint. For integrations whose API front door wants
172
+ * its own auth signal on top of the publishable key — an operator console
173
+ * proving a session to its reverse proxy, or a customer gateway in front
174
+ * of the streams API. `x-api-key` cannot be overridden through this map.
175
+ */
176
+ apiHeaders?: Record<string, string>;
167
177
  /**
168
178
  * QoE beacons + CMCD session attribution. Active only when the playback
169
179
  * response carries an analytics sid (the server-side flag) — without one
@@ -295,6 +305,11 @@ export declare interface FetchCatalogOptions {
295
305
  etag?: string;
296
306
  status?: MatchLiveStatus | MatchLiveStatus[];
297
307
  sport?: string;
308
+ /**
309
+ * Extra headers attached to every request to {@link baseUrl} — and only
310
+ * there: never to CDN or license hosts. `x-api-key` cannot be overridden.
311
+ */
312
+ apiHeaders?: Record<string, string>;
298
313
  }
299
314
 
300
315
  /**
@@ -315,6 +330,11 @@ export declare interface FetchTournamentOptions {
315
330
  signal?: AbortSignal;
316
331
  /** Prior ETag for a conditional GET (304 when unchanged) — only effective once havik-streams ETags `/v1/tournaments/{urn}` (parity with `/v1/matches/{urn}`). */
317
332
  etag?: string;
333
+ /**
334
+ * Extra headers attached to every request to {@link baseUrl} — and only
335
+ * there: never to CDN or license hosts. `x-api-key` cannot be overridden.
336
+ */
337
+ apiHeaders?: Record<string, string>;
318
338
  }
319
339
 
320
340
  /** Flatten a Catalog to a single match list (handy for grids). */
@@ -687,6 +707,14 @@ export declare interface ResolveOptions {
687
707
  */
688
708
  waitForLive?: WaitForLive;
689
709
  signal?: AbortSignal;
710
+ /**
711
+ * Extra headers attached to every request this call makes to {@link baseUrl}
712
+ * — and ONLY there: never to CDN manifest/segment hosts or DRM license
713
+ * endpoints. For integrations whose API front door wants its own auth
714
+ * signal on top of the publishable key (gateways, operator consoles).
715
+ * `x-api-key` cannot be overridden.
716
+ */
717
+ apiHeaders?: Record<string, string>;
690
718
  }
691
719
 
692
720
  /**
@@ -870,6 +898,11 @@ export declare interface WatchStatusOptions {
870
898
  onError?: (err: PlaybackError) => void;
871
899
  /** Poll interval in ms. Floored at 2000. Default: 10000 (catalog max-age). */
872
900
  intervalMs?: number;
901
+ /**
902
+ * Extra headers attached to every request to {@link baseUrl} — and only
903
+ * there: never to CDN or license hosts. `x-api-key` cannot be overridden.
904
+ */
905
+ apiHeaders?: Record<string, string>;
873
906
  }
874
907
 
875
908
  export declare interface WidevineInfo {