etro 0.12.1 → 0.14.0

package/dist/etro.d.ts

@@ -1,7 +1,7 @@
-import * as layer from './layer/index';
-import * as effect from './effect/index';
-import * as event from './event';
-import EtroObject from './object';
-export * from './movie';
-export * from './util';
-export { EtroObject, layer, effect, event };
+import * as layer from './layer/index';
+import * as effect from './effect/index';
+import * as event from './event';
+import EtroObject from './object';
+export * from './movie';
+export * from './util';
+export { EtroObject, layer, effect, event };

package/dist/event.d.ts

@@ -1,40 +1,40 @@
-/**
- * @module event
- */
-import EtroObject from './object';
-export interface Event {
-    target: EtroObject;
-    type: string;
-}
-export declare function deprecate(type: string, newType: string, message?: string): void;
-/**
- * Listen for an event or category of events.
- *
- * @param target - an etro object
- * @param type - the id of the type (can contain subtypes, such as
- * "type.subtype")
- * @param listener
- * @param options - options
- * @param options.once - if true, the listener will only be called once
- */
-export declare function subscribe(target: EtroObject, type: string, listener: <T extends Event>(T: any) => void, options?: {
-    once?: boolean;
-}): void;
-/**
- * Remove an event listener
- *
- * @param target - an etro object
- * @param type - the id of the type (can contain subtypes, such as
- * "type.subtype")
- * @param listener
- */
-export declare function unsubscribe(target: EtroObject, listener: <T extends Event>(T: any) => void): void;
-/**
- * Emits an event to all listeners
- *
- * @param target - an etro object
- * @param type - the id of the type (can contain subtypes, such as
- * "type.subtype")
- * @param event - any additional event data
- */
-export declare function publish(target: EtroObject, type: string, event: Record<string, unknown>): Event;
+/**
+ * @module event
+ */
+import EtroObject from './object';
+export interface Event {
+    target: EtroObject;
+    type: string;
+}
+export declare function deprecate(type: string, newType: string, message?: string): void;
+/**
+ * Listen for an event or category of events.
+ *
+ * @param target - an etro object
+ * @param type - the id of the type (can contain subtypes, such as
+ * "type.subtype")
+ * @param listener
+ * @param options - options
+ * @param options.once - if true, the listener will only be called once
+ */
+export declare function subscribe(target: EtroObject, type: string, listener: <T extends Event>(T: any) => void, options?: {
+    once?: boolean;
+}): void;
+/**
+ * Remove an event listener
+ *
+ * @param target - an etro object
+ * @param type - the id of the type (can contain subtypes, such as
+ * "type.subtype")
+ * @param listener
+ */
+export declare function unsubscribe(target: EtroObject, listener: <T extends Event>(T: any) => void): void;
+/**
+ * Emits an event to all listeners
+ *
+ * @param target - an etro object
+ * @param type - the id of the type (can contain subtypes, such as
+ * "type.subtype")
+ * @param event - any additional event data
+ */
+export declare function publish(target: EtroObject, type: string, event: Record<string, unknown>): Event;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-/**
- * The entry point
- * @module index
- */
-import * as etro from './etro';
-export default etro;
+/**
+ * The entry point
+ * @module index
+ */
+import * as etro from './etro';
+export default etro;

package/dist/layer/audio-source.d.ts

@@ -1,28 +1,28 @@
-import { Base, BaseOptions } from './base';
-declare type Constructor<T> = new (...args: unknown[]) => T;
-interface AudioSource extends Base {
-    /** HTML media element (an audio or video element) */
-    readonly source: HTMLAudioElement;
-    /** Audio source node for the media */
-    readonly audioNode: AudioNode;
-    playbackRate: number;
-    /** Seconds to skip ahead by */
-    sourceStartTime: number;
-}
-interface AudioSourceOptions extends Omit<BaseOptions, 'duration'> {
-    duration?: number;
-    /** HTML media element (an audio or video element) */
-    source: HTMLMediaElement;
-    /** Seconds to skip ahead by */
-    sourceStartTime?: number;
-    muted?: boolean;
-    volume?: number;
-    playbackRate?: number;
-    onload?: (source: HTMLMediaElement, options: AudioSourceOptions) => void;
-}
-/**
- * A layer that gets its audio from an HTMLMediaElement
- * @mixin AudioSourceMixin
- */
-declare function AudioSourceMixin<OptionsSuperclass extends BaseOptions>(superclass: Constructor<Base>): Constructor<AudioSource>;
-export { AudioSource, AudioSourceOptions, AudioSourceMixin };
+import { Base, BaseOptions } from './base';
+type Constructor<T> = new (...args: unknown[]) => T;
+interface AudioSource extends Base {
+    /** HTML media element (an audio or video element) */
+    readonly source: HTMLAudioElement;
+    /** Audio source node for the media */
+    readonly audioNode: AudioNode;
+    playbackRate: number;
+    /** Seconds to skip ahead by */
+    sourceStartTime: number;
+}
+interface AudioSourceOptions extends Omit<BaseOptions, 'duration'> {
+    duration?: number;
+    /** HTML media element (an audio or video element) */
+    source: HTMLMediaElement;
+    /** Seconds to skip ahead by */
+    sourceStartTime?: number;
+    muted?: boolean;
+    volume?: number;
+    playbackRate?: number;
+    onload?: (source: HTMLMediaElement, options: AudioSourceOptions) => void;
+}
+/**
+ * A layer that gets its audio from an HTMLMediaElement
+ * @mixin AudioSourceMixin
+ */
+declare function AudioSourceMixin<OptionsSuperclass extends BaseOptions>(superclass: Constructor<Base>): Constructor<AudioSource>;
+export { AudioSource, AudioSourceOptions, AudioSourceMixin };

package/dist/layer/audio.d.ts

@@ -1,27 +1,27 @@
-import { AudioSourceOptions } from './audio-source';
-interface AudioOptions extends Omit<AudioSourceOptions, 'source'> {
-    /**
-     * The raw html `<audio>` element
-     */
-    source: string | HTMLAudioElement;
-}
-declare const Audio_base: new (...args: unknown[]) => import("./audio-source").AudioSource;
-/**
- * Layer for an HTML audio element
- * @extends AudioSource
- */
-declare class Audio extends Audio_base {
-    /**
-     * The raw html `<audio>` element
-     */
-    source: HTMLAudioElement;
-    /**
-     * Creates an audio layer
-     */
-    constructor(options: AudioOptions);
-    /**
-     * @deprecated See {@link https://github.com/etro-js/etro/issues/131}
-     */
-    getDefaultOptions(): any;
-}
-export { Audio, AudioOptions };
+import { AudioSourceOptions } from './audio-source';
+interface AudioOptions extends Omit<AudioSourceOptions, 'source'> {
+    /**
+     * The raw html `<audio>` element
+     */
+    source: string | HTMLAudioElement;
+}
+declare const Audio_base: new (...args: unknown[]) => import("./audio-source").AudioSource;
+/**
+ * Layer for an HTML audio element
+ * @extends AudioSource
+ */
+declare class Audio extends Audio_base {
+    /**
+     * The raw html `<audio>` element
+     */
+    source: HTMLAudioElement;
+    /**
+     * Creates an audio layer
+     */
+    constructor(options: AudioOptions);
+    /**
+     * @deprecated See {@link https://github.com/etro-js/etro/issues/131}
+     */
+    getDefaultOptions(): any;
+}
+export { Audio, AudioOptions };

package/dist/layer/base.d.ts

@@ -1,128 +1,129 @@
-import EtroObject from '../object';
-import { Movie } from '../movie';
-interface BaseOptions {
-    /** The time in the movie at which this layer starts */
-    startTime: number;
-    duration: number;
-}
-/**
- * A layer outputs content for the movie
- */
-declare class Base implements EtroObject {
-    type: string;
-    publicExcludes: string[];
-    propertyFilters: Record<string, <T>(value: T) => T>;
-    enabled: boolean;
-    /**
-     * If the attached movie's playback position is in this layer
-     */
-    active: boolean;
-    /**
-     * The number of times this layer has been attached to a movie minus the
-     * number of times it's been detached. (Used for the movie's array proxy with
-     * `unshift`)
-     */
-    private _occurrenceCount;
-    private _startTime;
-    private _duration;
-    private _currentTime;
-    private _movie;
-    /**
-     * Creates a new empty layer
-     *
-     * @param options
-     * @param options.startTime - when to start the layer on the movie's
-     * timeline
-     * @param options.duration - how long the layer should last on the
-     * movie's timeline
-     */
-    constructor(options: BaseOptions);
-    /**
-     * Wait until this layer is ready to render
-     */
-    whenReady(): Promise<void>;
-    /**
-     * Attaches this layer to `movie` if not already attached.
-     * @ignore
-     */
-    tryAttach(movie: Movie): void;
-    /**
-     * Attaches this layer to `movie`
-     *
-     * Called when the layer is added to a movie's `layers` array.
-     *
-     * @param movie The movie to attach to
-     */
-    attach(movie: Movie): void;
-    /**
-     * Detaches this layer from its movie if the number of times `tryDetach` has
-     * been called (including this call) equals the number of times `tryAttach`
-     * has been called.
-     *
-     * @ignore
-     */
-    tryDetach(): void;
-    /**
-     * Detaches this layer from its movie
-     *
-     * Called when the layer is removed from a movie's `layers` array.
-     */
-    detach(): void;
-    /**
-     * Called when the layer is activated
-     */
-    start(): void;
-    /**
-     * Update {@link currentTime} when seeking
-     *
-     * This method is called when the movie seeks to a new time at the request of
-     * the user. {@link progress} is called when the movie's `currentTime` is
-     * updated due to playback.
-     *
-     * @param time - The new time in the layer
-     */
-    seek(time: number): void;
-    /**
-     * Update {@link currentTime} due to playback
-     *
-     * This method is called when the movie's `currentTime` is updated due to
-     * playback. {@link seek} is called when the movie seeks to a new time at the
-     * request of the user.
-     *
-     * @param time - The new time in the layer
-     */
-    progress(time: number): void;
-    /**
-     * Called when the movie renders and the layer is active
-     */
-    render(): void;
-    /**
-     * Called when the layer is deactivated
-     */
-    stop(): void;
-    get parent(): Movie;
-    /**
-     * The time in the movie at which this layer starts (in seconds)
-     */
-    get startTime(): number;
-    set startTime(val: number);
-    /**
-     * The current time of the movie relative to this layer (in seconds)
-     */
-    get currentTime(): number;
-    /**
-     * The duration of this layer (in seconds)
-     */
-    get duration(): number;
-    set duration(val: number);
-    /**
-     * `true` if this layer is ready to be rendered, `false` otherwise
-     */
-    get ready(): boolean;
-    get movie(): Movie;
-    /**
-     * @deprecated See {@link https://github.com/etro-js/etro/issues/131}
-     */
-    getDefaultOptions(): BaseOptions;
-}
-export { Base, BaseOptions };
+import EtroObject from '../object';
+import { Movie } from '../movie';
+interface BaseOptions {
+    /** The time in the movie at which this layer starts */
+    startTime: number;
+    duration: number;
+}
+/**
+ * A layer outputs content for the movie
+ */
+declare class Base implements EtroObject {
+    type: string;
+    publicExcludes: string[];
+    propertyFilters: Record<string, <T>(value: T) => T>;
+    enabled: boolean;
+    /**
+     * If the attached movie's playback position is in this layer
+     */
+    active: boolean;
+    /**
+     * The number of times this layer has been attached to a movie minus the
+     * number of times it's been detached. (Used for the movie's array proxy with
+     * `unshift`)
+     */
+    private _occurrenceCount;
+    private _startTime;
+    private _duration;
+    private _currentTime;
+    private _movie;
+    /**
+     * Creates a new empty layer
+     *
+     * @param options
+     * @param options.startTime - when to start the layer on the movie's
+     * timeline
+     * @param options.duration - how long the layer should last on the
+     * movie's timeline
+     */
+    constructor(options: BaseOptions);
+    /**
+     * Wait until this layer is ready to render
+     */
+    whenReady(): Promise<void>;
+    /**
+     * Attaches this layer to `movie` if not already attached.
+     * @ignore
+     */
+    tryAttach(movie: Movie): void;
+    /**
+     * Attaches this layer to `movie`
+     *
+     * Called when the layer is added to a movie's `layers` array.
+     *
+     * @param movie The movie to attach to
+     */
+    attach(movie: Movie): void;
+    /**
+     * Detaches this layer from its movie if the number of times `tryDetach` has
+     * been called (including this call) equals the number of times `tryAttach`
+     * has been called.
+     *
+     * @ignore
+     */
+    tryDetach(): void;
+    /**
+     * Detaches this layer from its movie
+     *
+     * Called when the layer is removed from a movie's `layers` array.
+     */
+    detach(): void;
+    /**
+     * Called when the layer is activated
+     */
+    start(): void;
+    /**
+     * Update {@link currentTime} when seeking
+     *
+     * This method is called when the movie seeks to a new time at the request of
+     * the user. {@link progress} is called when the movie's `currentTime` is
+     * updated due to playback.
+     *
+     * @param time - The new time in the layer
+     */
+    seek(time: number): void;
+    /**
+     * Update {@link currentTime} due to playback
+     *
+     * This method is called when the movie's `currentTime` is updated due to
+     * playback. {@link seek} is called when the movie seeks to a new time at the
+     * request of the user.
+     *
+     * @param time - The new time in the layer
+     */
+    progress(time: number): void;
+    /**
+     * Called when the movie renders and the layer is active
+     */
+    render(): void;
+    /**
+     * Called when the layer is deactivated
+     */
+    stop(): void;
+    get parent(): Movie;
+    /**
+     * The time in the movie at which this layer starts (in seconds)
+     */
+    get startTime(): number;
+    set startTime(val: number);
+    /**
+     * The current time of the movie relative to this layer (in seconds)
+     */
+    get currentTime(): number;
+    /**
+     * The duration of this layer (in seconds)
+     */
+    get duration(): number;
+    set duration(val: number);
+    /**
+     * `true` if this layer is ready to be rendered, `false` otherwise
+     */
+    get ready(): boolean;
+    get movie(): Movie;
+    /**
+     * @deprecated See {@link https://github.com/etro-js/etro/issues/131}
+     */
+    getDefaultOptions(): BaseOptions;
+    toJSON(): object;
+}
+export { Base, BaseOptions };

package/dist/layer/image.d.ts

@@ -1,20 +1,20 @@
-import { VisualSourceOptions } from './visual-source';
-interface ImageOptions extends Omit<VisualSourceOptions, 'source'> {
-    /**
-     * The raw html `<img>` element
-     */
-    source: string | HTMLImageElement;
-}
-declare const Image_base: new (...args: unknown[]) => import("./visual-source").VisualSource;
-/**
- * Layer for an HTML image element
- * @extends VisualSource
- */
-declare class Image extends Image_base {
-    /**
-     * The raw html `<img>` element
-     */
-    source: HTMLImageElement;
-    constructor(options: ImageOptions);
-}
-export { Image, ImageOptions };
+import { VisualSourceOptions } from './visual-source';
+interface ImageOptions extends Omit<VisualSourceOptions, 'source'> {
+    /**
+     * The raw html `<img>` element
+     */
+    source: string | HTMLImageElement;
+}
+declare const Image_base: new (...args: unknown[]) => import("./visual-source").VisualSource;
+/**
+ * Layer for an HTML image element
+ * @extends VisualSource
+ */
+declare class Image extends Image_base {
+    /**
+     * The raw html `<img>` element
+     */
+    source: HTMLImageElement;
+    constructor(options: ImageOptions);
+}
+export { Image, ImageOptions };

package/dist/layer/index.d.ts

@@ -1,11 +1,11 @@
-/**
- * @module layer
- */
-export * from './audio-source';
-export * from './audio';
-export * from './base';
-export * from './image';
-export * from './text';
-export * from './video';
-export * from './visual-source';
-export * from './visual';
+/**
+ * @module layer
+ */
+export * from './audio-source';
+export * from './audio';
+export * from './base';
+export * from './image';
+export * from './text';
+export * from './video';
+export * from './visual-source';
+export * from './visual';