@amazon/vinyl 3.0.0 → 3.1.0

package/dist/types/current/vinyl/VinylPatchOptions.js

@@ -1,11 +0,0 @@
-/*
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-import { defaultMediaElementPatchOptions } from '../patch/media/MediaElementPatchOptions';
-import { lazy } from '@amazon/vinyl-util';
-export const defaultPatchOptions = lazy(() => {
-    return {
-        media: defaultMediaElementPatchOptions.value,
-    };
-});

package/dist/types/ts3.7/patch/media/HtmlMediaElementPatch.d.ts

@@ -1,3 +0,0 @@
-import { Patch } from '@amazon/vinyl-util';
-export type HtmlMediaElementPatch = Patch<HTMLMediaElement, HTMLMediaElementEventMap>;
-//# sourceMappingURL=HtmlMediaElementPatch.d.ts.map

package/dist/types/ts3.7/patch/media/MediaElementPatchOptions.d.ts

@@ -1,19 +0,0 @@
-export interface MediaElementPatchOptions {
-    /**
-     * Playback events 'playing' and 'waiting' are unreliable after seeking.
-     *
-     * Risks for false positive: LOW. Timing of emitted playing events may be subtly
-     * different, but they will not be duplicated.
-     * Risks for false negative: MEDIUM. Certain playback events on affected platforms will be missed.
-     */
-    readonly unreliablePlaybackEvents?: boolean;
-    /**
-     * The affected user agent gets into a state where playback can become stalled and needs help getting unstuck.
-     */
-    readonly preventStalls?: boolean;
-}
-/**
- * Aggregates flags for toggling patches.
- */
-export declare const defaultMediaElementPatchOptions: import("@amazon/vinyl-util").Lazy<Required<MediaElementPatchOptions>>;
-//# sourceMappingURL=MediaElementPatchOptions.d.ts.map

package/dist/types/ts3.7/patch/media/patchMediaElement.d.ts

@@ -1,9 +0,0 @@
-import { PatchedRef } from '@amazon/vinyl-util';
-import { MediaElementPatchOptions } from './MediaElementPatchOptions';
-/**
- * Applies patches corresponding to the patch flags on the given media element.
- *
- * Adds logging for fabricated or squelched events.
- */
-export declare function patchMediaElement<T extends HTMLMediaElement = HTMLMediaElement>(media: T, options: MediaElementPatchOptions): PatchedRef<T>;
-//# sourceMappingURL=patchMediaElement.d.ts.map

package/dist/types/ts3.7/patch/media/patches/createPreventStallsPatch.d.ts

@@ -1,17 +0,0 @@
-import { HtmlMediaElementPatch } from '../HtmlMediaElementPatch';
-/**
- * The number of timeupdate events stuck at the same position before attempting to jiggle the playhead.
- * @private
- */
-export declare const MAX_UNCHANGED_COUNT = 10;
-/**
- * On affected UAs, playback can become stuck. timeupdate events are observed but playback position is never changing.
- * This patch applies a workaround which will pause and play again after max number of timeupdate events with no
- * actual time progression.
- */
-export declare function createPreventStallsPatch(media: HTMLMediaElement): HtmlMediaElementPatch;
-/**
- * Returns true if stall detection should be enabled for the current user agent.
- */
-export declare function requiresPreventStallsPatch(): boolean;
-//# sourceMappingURL=createPreventStallsPatch.d.ts.map

package/dist/types/ts3.7/patch/media/patches/createUnreliablePlaybackEventsPatch.d.ts

@@ -1,26 +0,0 @@
-import { HtmlMediaElementPatch } from '../HtmlMediaElementPatch';
-/**
- * The interval (in seconds) to poll for time progress in a media element.
- *
- * @private
- */
-export declare const UNRELIABLE_EVENTS_POLL_INTERVAL = 0.2;
-/**
- * Minimum amount of time playback must be stalled before fabricating a waiting event.
- */
-export declare const MIN_STALLED_BEFORE_FAB = 0.8;
-/**
- * Minimum amount of time playback must be progressing before fabricating a playing event.
- */
-export declare const MIN_PLAYING_BEFORE_FAB = 0.4;
-/**
- * Playback events such as playing, canPlay, and waiting are unreliable on this platform.
- * Watch playback state and fabricate events when necessary.
- */
-export declare function createUnreliablePlaybackEventsPatch(media: HTMLMediaElement): HtmlMediaElementPatch;
-/**
- * Chrome <= 53 has unreliable waiting events.
- * Safari, and Edge Legacy miss playing events after seeking.
- */
-export declare function requiresUnreliablePlaybackEventsPatch(): boolean;
-//# sourceMappingURL=createUnreliablePlaybackEventsPatch.d.ts.map

package/dist/types/ts3.7/vinyl/VinylPatchOptions.d.ts

@@ -1,10 +0,0 @@
-import { MediaElementPatchOptions } from '../patch/media/MediaElementPatchOptions';
-/**
- * Flags for applying patches.
- * Default flags will be applied based on user agent, but may be overridden during player creation.
- */
-export interface VinylPatchOptions {
-    readonly media: MediaElementPatchOptions;
-}
-export declare const defaultPatchOptions: import("@amazon/vinyl-util").Lazy<VinylPatchOptions>;
-//# sourceMappingURL=VinylPatchOptions.d.ts.map

package/dist/types/ts4.1/patch/media/HtmlMediaElementPatch.d.ts

@@ -1,3 +0,0 @@
-import type { Patch } from '@amazon/vinyl-util';
-export type HtmlMediaElementPatch = Patch<HTMLMediaElement, HTMLMediaElementEventMap>;
-//# sourceMappingURL=HtmlMediaElementPatch.d.ts.map

package/dist/types/ts4.1/patch/media/MediaElementPatchOptions.d.ts

@@ -1,19 +0,0 @@
-export interface MediaElementPatchOptions {
-    /**
-     * Playback events 'playing' and 'waiting' are unreliable after seeking.
-     *
-     * Risks for false positive: LOW. Timing of emitted playing events may be subtly
-     * different, but they will not be duplicated.
-     * Risks for false negative: MEDIUM. Certain playback events on affected platforms will be missed.
-     */
-    readonly unreliablePlaybackEvents?: boolean;
-    /**
-     * The affected user agent gets into a state where playback can become stalled and needs help getting unstuck.
-     */
-    readonly preventStalls?: boolean;
-}
-/**
- * Aggregates flags for toggling patches.
- */
-export declare const defaultMediaElementPatchOptions: import("@amazon/vinyl-util").Lazy<Required<MediaElementPatchOptions>>;
-//# sourceMappingURL=MediaElementPatchOptions.d.ts.map

package/dist/types/ts4.1/patch/media/patchMediaElement.d.ts

@@ -1,9 +0,0 @@
-import type { PatchedRef } from '@amazon/vinyl-util';
-import type { MediaElementPatchOptions } from './MediaElementPatchOptions';
-/**
- * Applies patches corresponding to the patch flags on the given media element.
- *
- * Adds logging for fabricated or squelched events.
- */
-export declare function patchMediaElement<T extends HTMLMediaElement = HTMLMediaElement>(media: T, options: MediaElementPatchOptions): PatchedRef<T>;
-//# sourceMappingURL=patchMediaElement.d.ts.map

package/dist/types/ts4.1/patch/media/patches/createPreventStallsPatch.d.ts

@@ -1,17 +0,0 @@
-import type { HtmlMediaElementPatch } from '../HtmlMediaElementPatch';
-/**
- * The number of timeupdate events stuck at the same position before attempting to jiggle the playhead.
- * @private
- */
-export declare const MAX_UNCHANGED_COUNT = 10;
-/**
- * On affected UAs, playback can become stuck. timeupdate events are observed but playback position is never changing.
- * This patch applies a workaround which will pause and play again after max number of timeupdate events with no
- * actual time progression.
- */
-export declare function createPreventStallsPatch(media: HTMLMediaElement): HtmlMediaElementPatch;
-/**
- * Returns true if stall detection should be enabled for the current user agent.
- */
-export declare function requiresPreventStallsPatch(): boolean;
-//# sourceMappingURL=createPreventStallsPatch.d.ts.map

package/dist/types/ts4.1/patch/media/patches/createUnreliablePlaybackEventsPatch.d.ts

@@ -1,26 +0,0 @@
-import type { HtmlMediaElementPatch } from '../HtmlMediaElementPatch';
-/**
- * The interval (in seconds) to poll for time progress in a media element.
- *
- * @private
- */
-export declare const UNRELIABLE_EVENTS_POLL_INTERVAL = 0.2;
-/**
- * Minimum amount of time playback must be stalled before fabricating a waiting event.
- */
-export declare const MIN_STALLED_BEFORE_FAB = 0.8;
-/**
- * Minimum amount of time playback must be progressing before fabricating a playing event.
- */
-export declare const MIN_PLAYING_BEFORE_FAB = 0.4;
-/**
- * Playback events such as playing, canPlay, and waiting are unreliable on this platform.
- * Watch playback state and fabricate events when necessary.
- */
-export declare function createUnreliablePlaybackEventsPatch(media: HTMLMediaElement): HtmlMediaElementPatch;
-/**
- * Chrome <= 53 has unreliable waiting events.
- * Safari, and Edge Legacy miss playing events after seeking.
- */
-export declare function requiresUnreliablePlaybackEventsPatch(): boolean;
-//# sourceMappingURL=createUnreliablePlaybackEventsPatch.d.ts.map

package/dist/types/ts4.1/vinyl/VinylPatchOptions.d.ts

@@ -1,10 +0,0 @@
-import type { MediaElementPatchOptions } from '../patch/media/MediaElementPatchOptions';
-/**
- * Flags for applying patches.
- * Default flags will be applied based on user agent, but may be overridden during player creation.
- */
-export interface VinylPatchOptions {
-    readonly media: MediaElementPatchOptions;
-}
-export declare const defaultPatchOptions: import("@amazon/vinyl-util").Lazy<VinylPatchOptions>;
-//# sourceMappingURL=VinylPatchOptions.d.ts.map

package/dist/types/ts4.7/patch/media/HtmlMediaElementPatch.d.ts

@@ -1,3 +0,0 @@
-import type { Patch } from '@amazon/vinyl-util';
-export type HtmlMediaElementPatch = Patch<HTMLMediaElement, HTMLMediaElementEventMap>;
-//# sourceMappingURL=HtmlMediaElementPatch.d.ts.map

package/dist/types/ts4.7/patch/media/MediaElementPatchOptions.d.ts

@@ -1,19 +0,0 @@
-export interface MediaElementPatchOptions {
-    /**
-     * Playback events 'playing' and 'waiting' are unreliable after seeking.
-     *
-     * Risks for false positive: LOW. Timing of emitted playing events may be subtly
-     * different, but they will not be duplicated.
-     * Risks for false negative: MEDIUM. Certain playback events on affected platforms will be missed.
-     */
-    readonly unreliablePlaybackEvents?: boolean;
-    /**
-     * The affected user agent gets into a state where playback can become stalled and needs help getting unstuck.
-     */
-    readonly preventStalls?: boolean;
-}
-/**
- * Aggregates flags for toggling patches.
- */
-export declare const defaultMediaElementPatchOptions: import("@amazon/vinyl-util").Lazy<Required<MediaElementPatchOptions>>;
-//# sourceMappingURL=MediaElementPatchOptions.d.ts.map

package/dist/types/ts4.7/patch/media/patchMediaElement.d.ts

@@ -1,9 +0,0 @@
-import { type PatchedRef } from '@amazon/vinyl-util';
-import type { MediaElementPatchOptions } from './MediaElementPatchOptions';
-/**
- * Applies patches corresponding to the patch flags on the given media element.
- *
- * Adds logging for fabricated or squelched events.
- */
-export declare function patchMediaElement<T extends HTMLMediaElement = HTMLMediaElement>(media: T, options: MediaElementPatchOptions): PatchedRef<T>;
-//# sourceMappingURL=patchMediaElement.d.ts.map

package/dist/types/ts4.7/patch/media/patches/createPreventStallsPatch.d.ts

@@ -1,17 +0,0 @@
-import type { HtmlMediaElementPatch } from '../HtmlMediaElementPatch';
-/**
- * The number of timeupdate events stuck at the same position before attempting to jiggle the playhead.
- * @private
- */
-export declare const MAX_UNCHANGED_COUNT = 10;
-/**
- * On affected UAs, playback can become stuck. timeupdate events are observed but playback position is never changing.
- * This patch applies a workaround which will pause and play again after max number of timeupdate events with no
- * actual time progression.
- */
-export declare function createPreventStallsPatch(media: HTMLMediaElement): HtmlMediaElementPatch;
-/**
- * Returns true if stall detection should be enabled for the current user agent.
- */
-export declare function requiresPreventStallsPatch(): boolean;
-//# sourceMappingURL=createPreventStallsPatch.d.ts.map

package/dist/types/ts4.7/patch/media/patches/createUnreliablePlaybackEventsPatch.d.ts

@@ -1,26 +0,0 @@
-import type { HtmlMediaElementPatch } from '../HtmlMediaElementPatch';
-/**
- * The interval (in seconds) to poll for time progress in a media element.
- *
- * @private
- */
-export declare const UNRELIABLE_EVENTS_POLL_INTERVAL = 0.2;
-/**
- * Minimum amount of time playback must be stalled before fabricating a waiting event.
- */
-export declare const MIN_STALLED_BEFORE_FAB = 0.8;
-/**
- * Minimum amount of time playback must be progressing before fabricating a playing event.
- */
-export declare const MIN_PLAYING_BEFORE_FAB = 0.4;
-/**
- * Playback events such as playing, canPlay, and waiting are unreliable on this platform.
- * Watch playback state and fabricate events when necessary.
- */
-export declare function createUnreliablePlaybackEventsPatch(media: HTMLMediaElement): HtmlMediaElementPatch;
-/**
- * Chrome <= 53 has unreliable waiting events.
- * Safari, and Edge Legacy miss playing events after seeking.
- */
-export declare function requiresUnreliablePlaybackEventsPatch(): boolean;
-//# sourceMappingURL=createUnreliablePlaybackEventsPatch.d.ts.map

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

@@ -1,10 +0,0 @@
-import type { MediaElementPatchOptions } from '../patch/media/MediaElementPatchOptions';
-/**
- * Flags for applying patches.
- * Default flags will be applied based on user agent, but may be overridden during player creation.
- */
-export interface VinylPatchOptions {
-    readonly media: MediaElementPatchOptions;
-}
-export declare const defaultPatchOptions: import("@amazon/vinyl-util").Lazy<VinylPatchOptions>;
-//# sourceMappingURL=VinylPatchOptions.d.ts.map

package/dist/unit/types/current/patch/media/MediaElementPatchOptions.test.d.ts

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

package/dist/unit/types/current/patch/media/MediaElementPatchOptions.test.d.ts.map

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

package/dist/unit/types/current/patch/media/MediaElementPatchOptions.test.js

@@ -1,17 +0,0 @@
-/*
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-import { defaultMediaElementPatchOptions, } from '@amazon/vinyl';
-var any = jasmine.any;
-var objectContaining = jasmine.objectContaining;
-describe('defaultMediaElementPatchOptions', () => {
-    afterEach(() => {
-        defaultMediaElementPatchOptions.clear();
-    });
-    it('provides a value with the default patch flags', () => {
-        expect(defaultMediaElementPatchOptions.value).toEqual(objectContaining({
-            unreliablePlaybackEvents: any(Boolean),
-        }));
-    });
-});

package/dist/unit/types/current/patch/media/patchMediaElement.test.d.ts

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

package/dist/unit/types/current/patch/media/patchMediaElement.test.d.ts.map

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

package/dist/unit/types/current/patch/media/patchMediaElement.test.js

@@ -1,36 +0,0 @@
-/*
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-import { patchMediaElement } from '@amazon/vinyl';
-import { MockHTMLAudioElement } from '@amazon/vinyl-util/browserTestUtil';
-import { useMockLogger } from '@amazon/vinyl-util/testUtil';
-describe('patchMediaElement', () => {
-    const logger = useMockLogger();
-    it('applies patches based on the provided flags', () => {
-        const media = new MockHTMLAudioElement();
-        {
-            logger.value.debug.calls.reset();
-            const options = {
-                unreliablePlaybackEvents: true,
-                preventStalls: true,
-            };
-            const patchedRef = patchMediaElement(media, options);
-            expect(logger.value.debug).toHaveBeenCalledTimes(Object.keys(options).length);
-            patchedRef.dispose();
-        }
-        {
-            logger.value.debug.calls.reset();
-            const options = {};
-            const patchedRef = patchMediaElement(media, options);
-            expect(logger.value.debug).toHaveBeenCalledTimes(0);
-            patchedRef.dispose();
-        }
-        {
-            logger.value.debug.calls.reset();
-            const patchedRef = patchMediaElement(media, {});
-            expect(logger.value.debug).toHaveBeenCalledTimes(0);
-            patchedRef.dispose();
-        }
-    });
-});

package/dist/unit/types/current/patch/media/patches/createPreventStallsPatch.test.d.ts

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

package/dist/unit/types/current/patch/media/patches/createPreventStallsPatch.test.d.ts.map

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

package/dist/unit/types/current/patch/media/patches/createPreventStallsPatch.test.js

@@ -1,93 +0,0 @@
-/*
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-import { createPreventStallsPatch, MAX_UNCHANGED_COUNT, requiresPreventStallsPatch, } from '@amazon/vinyl';
-import { patchTarget, setUserAgent } from '@amazon/vinyl-util';
-import { implementEventFakes, MockHTMLAudioElement, mockEvent, } from '@amazon/vinyl-util/browserTestUtil';
-import { useMockLogger } from '@amazon/vinyl-util/testUtil';
-describe('createPreventStallsPatch', () => {
-    let media;
-    let mediaEventFakes;
-    let patchedMedia;
-    let patchedRef;
-    let disposed = false;
-    useMockLogger();
-    beforeEach(() => {
-        disposed = true;
-        media = new MockHTMLAudioElement();
-        mediaEventFakes = implementEventFakes(media);
-        media.play.and.resolveTo(void 0);
-        patchedRef = patchTarget(media, createPreventStallsPatch);
-        patchedMedia = patchedRef.patched;
-    });
-    afterEach(() => {
-        if (!disposed)
-            patchedRef.dispose();
-    });
-    function dispatchTimeUpdates(count, incrementTime = false) {
-        for (let i = 0; i < count; i++) {
-            media.dispatchEvent(mockEvent('timeupdate'));
-            if (incrementTime)
-                media.currentTime += 0.1;
-        }
-    }
-    describe('when timeupdate events repeatedly occur', () => {
-        describe('and playback is paused', () => {
-            it('does nothing', () => {
-                media.paused = true;
-                dispatchTimeUpdates(MAX_UNCHANGED_COUNT);
-                expect(media.pause).not.toHaveBeenCalled();
-                expect(media.play).not.toHaveBeenCalled();
-            });
-        });
-        describe('and time does not progress', () => {
-            it('stops and restarts playback', () => {
-                patchedMedia.currentTime = 10;
-                media.paused = false;
-                media.play.calls.reset();
-                dispatchTimeUpdates(MAX_UNCHANGED_COUNT);
-                expect(media.pause).not.toHaveBeenCalled();
-                expect(media.play).not.toHaveBeenCalled();
-                dispatchTimeUpdates(1);
-                expect(media.pause).toHaveBeenCalledOnceWith();
-                expect(media.play).toHaveBeenCalledOnceWith();
-                media.pause.calls.reset();
-                media.play.calls.reset();
-                // Once stuck, do not repeatedly attempt to fix
-                dispatchTimeUpdates(MAX_UNCHANGED_COUNT * 2);
-                expect(media.pause).not.toHaveBeenCalled();
-                expect(media.play).not.toHaveBeenCalled();
-                // Unstuck
-                dispatchTimeUpdates(MAX_UNCHANGED_COUNT * 2, true);
-                expect(media.pause).not.toHaveBeenCalled();
-                expect(media.play).not.toHaveBeenCalled();
-                // Once unstuck, allow detection of stuck state again.
-                dispatchTimeUpdates(MAX_UNCHANGED_COUNT + 1);
-                expect(media.pause).toHaveBeenCalledOnceWith();
-                expect(media.play).toHaveBeenCalledOnceWith();
-            });
-        });
-    });
-    describe('when patch is disposed', () => {
-        it('removes listeners', () => {
-            expect(mediaEventFakes.hasAnyListeners()).toBeTrue();
-            patchedRef.dispose();
-            expect(mediaEventFakes.hasAnyListeners()).toBeFalse();
-            disposed = true;
-        });
-    });
-});
-describe('requiresPreventStallsPatch', () => {
-    function testForUa(userAgent, expected) {
-        setUserAgent(userAgent);
-        expect(requiresPreventStallsPatch())
-            .withContext(`requiresPreventStallsPatch`)
-            .toEqual(expected);
-    }
-    it('is true when browser is Edge Legacy', () => {
-        testForUa('Edge/18.0.0', true);
-        testForUa('Edg/108.0.0', false);
-        testForUa('Chrome/120.0.0', false);
-    });
-});

package/dist/unit/types/current/patch/media/patches/createUnreliablePlaybackEventsPatch.test.d.ts

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

package/dist/unit/types/current/patch/media/patches/createUnreliablePlaybackEventsPatch.test.d.ts.map

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