wavesurfer.js 7.5.4 → 7.5.5

package/README.md

@@ -34,7 +34,7 @@ const wavesurfer = WaveSurfer.create({
 
 To import one of the plugins, e.g. the [Regions plugin](https://wavesurfer.xyz/examples/?regions.js):
 ```js
-import Regions from 'wavesurfer.js/dist/plugins/regions.js'
+import Regions from 'wavesurfer.js/dist/plugins/regions.esm.js'
 ```
 
 Or as a script tag that will export `WaveSurfer.Regions`:

package/dist/wavesurfer.d.ts

@@ -1,6 +1,91 @@
-import type { GenericPlugin } from './base-plugin.js';
-import Player from './player.js';
-export type WaveSurferOptions = {
+type GeneralEventTypes = {
+    [EventName: string]: unknown[];
+};
+type EventListener<EventTypes extends GeneralEventTypes, EventName extends keyof EventTypes> = (...args: EventTypes[EventName]) => void;
+/** A simple event emitter that can be used to listen to and emit events. */
+declare class EventEmitter<EventTypes extends GeneralEventTypes> {
+    private listeners;
+    /** Add an event listener */
+    addEventListener<EventName extends keyof EventTypes>(event: EventName, listener: EventListener<EventTypes, EventName>, options?: {
+        once?: boolean;
+    }): () => void;
+    removeEventListener<EventName extends keyof EventTypes>(event: EventName, listener: EventListener<EventTypes, EventName>): void;
+    /** Subscribe to an event. Returns an unsubscribe function. */
+    on: <EventName extends keyof EventTypes>(event: EventName, listener: EventListener<EventTypes, EventName>, options?: {
+        once?: boolean;
+    }) => () => void;
+    /** Unsubscribe from an event */
+    un: <EventName extends keyof EventTypes>(event: EventName, listener: EventListener<EventTypes, EventName>) => void;
+    /** Subscribe to an event only once */
+    once<EventName extends keyof EventTypes>(event: EventName, listener: EventListener<EventTypes, EventName>): () => void;
+    /** Clear all events */
+    unAll(): void;
+    /** Emit an event */
+    protected emit<EventName extends keyof EventTypes>(eventName: EventName, ...args: EventTypes[EventName]): void;
+}
+
+type BasePluginEvents = {
+    destroy: [];
+};
+type GenericPlugin = BasePlugin<BasePluginEvents, unknown>;
+declare class BasePlugin<EventTypes extends BasePluginEvents, Options> extends EventEmitter<EventTypes> {
+    protected wavesurfer?: WaveSurfer;
+    protected subscriptions: (() => void)[];
+    protected options: Options;
+    constructor(options: Options);
+    onInit(): void;
+    init(wavesurfer: WaveSurfer): void;
+    destroy(): void;
+}
+
+type PlayerOptions = {
+    media?: HTMLMediaElement;
+    mediaControls?: boolean;
+    autoplay?: boolean;
+    playbackRate?: number;
+};
+declare class Player<T extends GeneralEventTypes> extends EventEmitter<T> {
+    protected media: HTMLMediaElement;
+    private isExternalMedia;
+    constructor(options: PlayerOptions);
+    protected onMediaEvent(event: keyof HTMLMediaElementEventMap, callback: () => void, options?: AddEventListenerOptions): () => void;
+    protected onceMediaEvent(event: keyof HTMLMediaElementEventMap, callback: () => void): () => void;
+    protected getSrc(): string;
+    private revokeSrc;
+    protected setSrc(url: string, blob?: Blob): void;
+    protected destroy(): void;
+    protected setMediaElement(element: HTMLMediaElement): void;
+    /** Start playing the audio */
+    play(): Promise<void>;
+    /** Pause the audio */
+    pause(): void;
+    /** Check if the audio is playing */
+    isPlaying(): boolean;
+    /** Jumpt to a specific time in the audio (in seconds) */
+    setTime(time: number): void;
+    /** Get the duration of the audio in seconds */
+    getDuration(): number;
+    /** Get the current audio position in seconds */
+    getCurrentTime(): number;
+    /** Get the audio volume */
+    getVolume(): number;
+    /** Set the audio volume */
+    setVolume(volume: number): void;
+    /** Get the audio muted state */
+    getMuted(): boolean;
+    /** Mute or unmute the audio */
+    setMuted(muted: boolean): void;
+    /** Get the playback speed */
+    getPlaybackRate(): number;
+    /** Set the playback speed, pass an optional false to NOT preserve the pitch */
+    setPlaybackRate(rate: number, preservePitch?: boolean): void;
+    /** Get the HTML media element */
+    getMediaElement(): HTMLMediaElement;
+    /** Set a sink id to change the audio output device */
+    setSinkId(sinkId: string): Promise<void>;
+}
+
+type WaveSurferOptions = {
     /** Required: an HTML element or selector where the waveform will be rendered */
     container: HTMLElement | string;
     /** The height of the waveform in pixels, or "auto" to fill the container height */
@@ -80,7 +165,7 @@ declare const defaultOptions: {
     autoCenter: boolean;
     sampleRate: number;
 };
-export type WaveSurferEvents = {
+type WaveSurferEvents = {
     /** When audio starts loading */
     load: [url: string];
     /** During audio loading */
@@ -189,4 +274,5 @@ declare class WaveSurfer extends Player<WaveSurferEvents> {
     /** Unmount wavesurfer */
     destroy(): void;
 }
-export default WaveSurfer;
+
+export { type WaveSurferEvents, type WaveSurferOptions, WaveSurfer as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wavesurfer.js",
-  "version": "7.5.4",
+  "version": "7.5.5",
   "license": "BSD-3-Clause",
   "author": "katspaugh",
   "description": "Navigable audio waveform player",
@@ -28,17 +28,17 @@
   "types": "./dist/wavesurfer.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/wavesurfer.js",
+      "import": "./dist/wavesurfer.esm.js",
       "types": "./dist/wavesurfer.d.ts",
       "require": "./dist/wavesurfer.cjs"
     },
     "./dist/plugins/*.js": {
-      "import": "./dist/plugins/*.js",
+      "import": "./dist/plugins/*.esm.js",
       "types": "./dist/plugins/*.d.ts",
       "require": "./dist/plugins/*.cjs"
     },
     "./plugins/*": {
-      "import": "./dist/plugins/*.js",
+      "import": "./dist/plugins/*.esm.js",
       "types": "./dist/plugins/*.d.ts",
       "require": "./dist/plugins/*.cjs"
     },
@@ -56,7 +56,7 @@
     "cypress": "cypress open --e2e",
     "cypress:canary": "cypress open --e2e -b chrome:canary",
     "test": "cypress run",
-    "serve": "npx live-server --port=9090 --no-browser --ignore='.*'",
+    "serve": "npx live-server --port=9090 --no-browser --ignore='.*,src'",
     "start": "npm run build:dev & npm run serve"
   },
   "devDependencies": {
@@ -71,6 +71,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "prettier": "^2.8.7",
     "rollup": "^3.26.2",
+    "rollup-plugin-dts": "^6.1.0",
     "typescript": "^5.0.4"
   }
 }