@amazon/vinyl 1.1.1 → 2.0.0

package/dist/types/ts4.7/vinyl/createVinylFactories.d.ts

@@ -11,6 +11,7 @@ import type { TrackControllerImplDeps, TrackControllerImplOptions } from '../tra
 import { TrackControllerImpl } from '../track/TrackController';
 import type { VinylPatchOptions } from './VinylPatchOptions';
 import { type QualitySelectorImplOptions } from '../streaming/abr/QualitySelectorImpl';
+import { AdControllerImpl, type AdControllerImplDeps, type AdControllerImplOptions } from '../ad/AdControllerImpl';
 import { type DrmOptions } from '../drm/DrmOptions';
 import { commonEmeFactory } from '../drm/commonEme/CommonEmeFactory';
 import { DrmControllerImpl, type DrmControllerImplDeps } from '../drm/DrmControllerImpl';
@@ -18,8 +19,9 @@ import { LoudnessNormalizationControllerImpl } from '../playback/loudness/Loudne
 import { AutoResetControllerImpl, type AutoResetControllerImplDeps, type AutoResetControllerImplOptions } from '../track/AutoResetController';
 import type { Dependencies, Factories } from '@amazon/vinyl-di';
 import type { ContentStreamingOptions } from '../streaming/ContentStreamingOptions';
-import { type VinylOptions } from '../vinyl/VinylOptions';
+import { type VinylOptions } from './VinylOptions';
 import type { ObservableValue } from '@amazon/vinyl-observable';
+import { defaultAdLoadOptionsResolver } from '../ad/defaultAdLoadOptionsResolver';
 /**
  * Configuration used by the default dependency factories for Vinyl.
  *
@@ -60,6 +62,10 @@ export interface VinylDependencyOptions {
      * Configuration for auto-reset behavior.
      */
     readonly autoReset?: Partial<AutoResetControllerImplOptions>;
+    /**
+     * Configuration for the ad controller.
+     */
+    readonly adController?: Partial<AdControllerImplOptions>;
 }
 /**
  * Creates the dependency factories for a standard player.
@@ -81,22 +87,23 @@ export declare function createVinylFactories(options: VinylDependencyOptions): {
     }) => LoudnessNormalizationControllerImpl;
     capabilities: (deps: CapabilitiesImplDeps) => CapabilitiesImpl;
     requestInterceptor: () => typeof noop;
-    trackFactory: (deps: VinylTrackFactoryDeps) => import("../track/TrackFactory").TrackFactory<import("..").SourceObjectTrackLoadOptions | import("..").SourceTrackLoadOptions | import("..").DashTrackLoadOptions | import("..").HlsTrackLoadOptions>;
+    trackFactory: (deps: VinylTrackFactoryDeps) => import("..").TrackFactory<import("..").SourceObjectTrackLoadOptions | import("..").SourceTrackLoadOptions | import("..").DashTrackLoadOptions | import("..").HlsTrackLoadOptions>;
+    adTrackLoadOptionsProvider: () => typeof defaultAdLoadOptionsResolver;
     trackController: (deps: TrackControllerImplDeps<any>) => TrackControllerImpl<any>;
-    drmKeySystemResolver: () => import("../drm/DrmKeySystemResolver").DrmKeySystemResolver;
+    drmKeySystemResolver: () => import("..").DrmKeySystemResolver;
     drmController: (deps: DrmControllerImplDeps) => DrmControllerImpl;
     commonEme: typeof commonEmeFactory;
     autoResetController: (deps: AutoResetControllerImplDeps) => AutoResetControllerImpl;
-    createDashFactories: (deps: import("../track/dash/createDashFactories").DashFactoryDeps) => (/**
-     * Configuration for segmented streaming tracks (hls / dash).
-     */ loadOptions: import("..").DashTrackLoadOptions) => {
-        contentTypesValue: typeof import("..").createDashContentTypesValue;
+    adController: (deps: AdControllerImplDeps) => AdControllerImpl;
+    createDashFactories: (deps: import("..").DashFactoryDeps) => (loadOptions: import("..").DashTrackLoadOptions) => {
+        baseContentTypesValue: typeof import("..").createDashContentTypesValue;
+        contentTypesValue: typeof import("..").createAllowedContentTypesValue;
         baseUrlSelector: () => import("..").BaseUrlSelector;
         segmentRequestInit: () => import("@amazon/vinyl-util").Maybe<Readonly<Omit<RequestInit, "signal">>>;
         manifestProvider: (deps: {
             readonly requestInterceptor: import("@amazon/vinyl-util").RequestInterceptor;
         }) => import("..").DashManifestProvider;
-        manifestController: (deps: import("..").DashManifestControllerImplDeps) => import("..").DashManifestController;
+        manifestController: (deps: import("..").ManifestControllerImplDeps<import("..").DashManifestData>) => import("..").ManifestControllerImpl<import("..").DashManifestData>;
         mediaSourceFactory: () => typeof import("..").createMediaSource;
         mediaQualityMetadataResolver: (deps: import("..").DashMediaQualityMetadataResolverDeps) => import("..").DashMediaQualityMetadataResolver;
         mediaSourceController: (deps: import("..").MediaSourceControllerImplDeps) => import("..").MediaSourceControllerImpl;
@@ -112,26 +119,44 @@ export declare function createVinylFactories(options: VinylDependencyOptions): {
         contentStreamFactory: typeof import("..").createContentStreamFactory;
         qualitySelector: (deps: {
             options: ObservableValue<Pick<VinylOptions, "abr">>;
-        }) => import("../streaming/abr/QualitySelectorImpl").QualitySelectorImpl;
+        }) => import("..").QualitySelectorImpl;
+        preferredAudioLanguage: (deps: {
+            options: ObservableValue<Pick<VinylOptions, "preferredAudioLanguage">>;
+        }) => ObservableValue<string | readonly string[] | null>;
+        allowedContentTypes: (deps: {
+            options: ObservableValue<Pick<VinylOptions, "allowedContentTypes">>;
+        }) => ObservableValue<readonly import("..").RestrictableContentType[] | null>;
+        preferDescriptiveAudio: (deps: {
+            options: ObservableValue<Pick<VinylOptions, "preferDescriptiveAudio">>;
+        }) => ObservableValue<boolean>;
+        abr: (deps: {
+            options: ObservableValue<Pick<VinylOptions, "abr">>;
+        }) => ObservableValue<QualitySelectorImplOptions>;
         manifestTransformed: typeof import("..").createDefaultDashManifestTransformer;
         mediaTimeline: (deps: import("..").BuildDashMediaTimelineDeps & {
             readonly manifestTransformed: ObservableValue<Promise<import("..").DashManifestData>>;
         }) => ObservableValue<Promise<import("..").MediaTimeline>>;
         mediaTimelineTransformed: typeof import("..").createDefaultMediaTimelineTransformer;
-        options: import("@amazon/vinyl-di").Factory<ObservableValue<{
-            readonly abr: QualitySelectorImplOptions;
-            readonly preferredAudioLanguage: string | null;
-        }>>;
+        textTrackController: (deps: {
+            readonly media: HTMLMediaElement;
+            readonly manifestTransformed: ObservableValue<Promise<import("..").DashManifestData>>;
+            readonly options: ObservableValue<Pick<VinylOptions, "preferredTextLanguage" | "textCueStyle">>;
+        }) => import("..").SidecarTextTrackController;
+        options: import("@amazon/vinyl-di").Factory<ObservableValue<Pick<VinylOptions, "abr" | "preferredAudioLanguage" | "preferredTextLanguage" | "preferDescriptiveAudio" | "allowedContentTypes" | "textCueStyle">>>;
         playbackController: import("@amazon/vinyl-di").Factory<import("..").PlaybackController>;
         playbackSource: import("@amazon/vinyl-di").Factory<import("..").PlaybackSource>;
-        drmKeySystemResolver: import("@amazon/vinyl-di").Factory<import("../drm/DrmKeySystemResolver").DrmKeySystemResolver>;
+        drmKeySystemResolver: import("@amazon/vinyl-di").Factory<import("..").DrmKeySystemResolver>;
         requestInterceptor: import("@amazon/vinyl-di").Factory<import("@amazon/vinyl-util").RequestInterceptor>;
         drmController: import("@amazon/vinyl-di").Factory<import("..").DrmController>;
         capabilities: import("@amazon/vinyl-di").Factory<import("..").Capabilities>;
+        media: import("@amazon/vinyl-di").Factory<HTMLMediaElement>;
+        adController: import("@amazon/vinyl-di").Factory<import("..").AdController>;
     };
-    createHlsFactories: (deps: import("../track/hls/createHlsFactories").HlsFactoryDeps) => (loadOptions: import("..").HlsTrackLoadOptions) => {
-        contentTypesValue: typeof import("..").createHlsContentTypesValue;
-        manifestController: () => import("..").HlsManifestControllerImpl;
+    createHlsFactories: (deps: import("..").HlsFactoryDeps) => (loadOptions: import("..").HlsTrackLoadOptions) => {
+        baseContentTypesValue: typeof import("..").createHlsContentTypesValue;
+        contentTypesValue: typeof import("..").createAllowedContentTypesValue;
+        manifestProvider: () => import("..").HlsManifestProvider;
+        manifestController: (deps: import("..").ManifestControllerImplDeps<import("..").HlsManifestData>) => import("..").ManifestControllerImpl<import("..").HlsManifestData>;
         manifestTransformed: typeof import("..").createDefaultHlsManifestTransformer;
         mediaQualityMetadataResolver: () => import("..").HlsMediaQualityMetadataResolver;
         mediaSourceFactory: () => typeof import("..").createMediaSource;
@@ -149,21 +174,37 @@ export declare function createVinylFactories(options: VinylDependencyOptions): {
         contentStreamFactory: typeof import("..").createContentStreamFactory;
         qualitySelector: (deps: {
             options: ObservableValue<Pick<VinylOptions, "abr">>;
-        }) => import("../streaming/abr/QualitySelectorImpl").QualitySelectorImpl;
+        }) => import("..").QualitySelectorImpl;
+        preferredAudioLanguage: (deps: {
+            options: ObservableValue<Pick<VinylOptions, "preferredAudioLanguage">>;
+        }) => ObservableValue<string | readonly string[] | null>;
+        allowedContentTypes: (deps: {
+            options: ObservableValue<Pick<VinylOptions, "allowedContentTypes">>;
+        }) => ObservableValue<readonly import("..").RestrictableContentType[] | null>;
+        preferDescriptiveAudio: (deps: {
+            options: ObservableValue<Pick<VinylOptions, "preferDescriptiveAudio">>;
+        }) => ObservableValue<boolean>;
+        abr: (deps: {
+            options: ObservableValue<Pick<VinylOptions, "abr">>;
+        }) => ObservableValue<QualitySelectorImplOptions>;
         mediaTimeline: (deps: import("..").BuildHlsMediaTimelineDeps & {
             readonly manifestTransformed: ObservableValue<Promise<import("..").HlsManifestData>>;
         }) => ObservableValue<Promise<import("..").MediaTimeline>>;
         mediaTimelineTransformed: typeof import("..").createDefaultMediaTimelineTransformer;
-        options: import("@amazon/vinyl-di").Factory<ObservableValue<{
-            readonly abr: QualitySelectorImplOptions;
-            readonly preferredAudioLanguage: string | null;
-        }>>;
+        textTrackController: (deps: {
+            readonly media: HTMLMediaElement;
+            readonly manifestTransformed: ObservableValue<Promise<import("..").HlsManifestData>>;
+            readonly options: ObservableValue<Pick<VinylOptions, "preferredTextLanguage" | "textCueStyle">>;
+        }) => import("..").SidecarTextTrackController;
+        options: import("@amazon/vinyl-di").Factory<ObservableValue<Pick<VinylOptions, "abr" | "preferredAudioLanguage" | "preferredTextLanguage" | "preferDescriptiveAudio" | "allowedContentTypes" | "textCueStyle">>>;
         playbackController: import("@amazon/vinyl-di").Factory<import("..").PlaybackController>;
         playbackSource: import("@amazon/vinyl-di").Factory<import("..").PlaybackSource>;
-        drmKeySystemResolver: import("@amazon/vinyl-di").Factory<import("../drm/DrmKeySystemResolver").DrmKeySystemResolver>;
+        drmKeySystemResolver: import("@amazon/vinyl-di").Factory<import("..").DrmKeySystemResolver>;
         requestInterceptor: import("@amazon/vinyl-di").Factory<import("@amazon/vinyl-util").RequestInterceptor>;
         drmController: import("@amazon/vinyl-di").Factory<import("..").DrmController>;
         capabilities: import("@amazon/vinyl-di").Factory<import("..").Capabilities>;
+        media: import("@amazon/vinyl-di").Factory<HTMLMediaElement>;
+        adController: import("@amazon/vinyl-di").Factory<import("..").AdController>;
     };
 };
 /**

package/dist/unit/types/current/ad/AdController.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AdController.test.d.ts.map

package/dist/unit/types/current/ad/AdController.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AdController.test.d.ts","sourceRoot":"","sources":["../../../../../test/unit/ad/AdController.test.ts"],"names":[],"mappings":""}

package/dist/unit/types/current/ad/AdController.test.js

@@ -0,0 +1,10 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { expectTypeStrictlyEquals } from '@amazon/vinyl-util/browserTestUtil';
+describe('ALL_AD_EVENTS', () => {
+    it('provides a comprehensive list of all ad controller state events', () => {
+        expectTypeStrictlyEquals(true);
+    });
+});

package/dist/unit/types/current/ad/AdControllerImpl.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AdControllerImpl.test.d.ts.map

package/dist/unit/types/current/ad/AdControllerImpl.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AdControllerImpl.test.d.ts","sourceRoot":"","sources":["../../../../../test/unit/ad/AdControllerImpl.test.ts"],"names":[],"mappings":""}