yukimu 1.2.0 → 2.0.0

package/dist/Player.d.ts

@@ -1,8 +1,21 @@
+/** Yukimu v2.0.0 — Player with State Safety & Bitrate Optimization */
 import { Queue } from "./Queue";
 import { PlayerState } from "./Constants";
 import type { Yukimu } from "./Yukimu";
 import type { Node } from "./Node";
-import type { Track, PlayerOptions, FilterOptions } from "./types";
+import type { Track, PlayerOptions, FilterOptions, LoopMode, BoostTier } from "./types";
+/**
+ * Represents an audio player for a specific Discord guild.
+ *
+ * Critical fixes from v1:
+ * 1. play() — only sets playing=true AFTER the REST call succeeds
+ * 2. pause() — paused tracks are still "playing" from Lavalink's perspective
+ * 3. moveToNode() — properly re-sends voice state to the new node
+ * 4. sendVoicePayload() — deferred until connector is ready (safe for startup)
+ * 5. Proper cleanup in destroy() — all state, timers, and references
+ * 6. Input validation on filter values
+ * 7. Boost-tier-aware audio optimization
+ */
 export declare class Player {
     readonly manager: Yukimu;
     node: Node;
@@ -17,7 +30,8 @@ export declare class Player {
     ping: number;
     lastUpdated: number;
     volume: number;
-    loop: "none" | "track" | "queue";
+    loop: LoopMode;
+    autoplay: boolean;
     sessionId: string | null;
     voiceToken: string | null;
     voiceEndpoint: string | null;
@@ -25,22 +39,52 @@ export declare class Player {
     selfMute: boolean;
     filters: FilterOptions;
     readonly data: Map<string, unknown>;
-    autoplay: boolean;
     constructor(manager: Yukimu, node: Node, options: PlayerOptions);
     get connected(): boolean;
-    /** Real-time position estimate */
+    /**
+     * Estimated real-time position accounting for time since last update.
+     * Returns the actual position (capped at track length).
+     */
     get realPosition(): number;
+    /**
+     * Get the current boost tier of the guild this player is in.
+     */
+    get boostTier(): BoostTier;
     sendVoicePayload(channelId: string | null, selfDeaf: boolean, selfMute: boolean): void;
+    /**
+     * Check if we have all voice connection data and send it to Lavalink.
+     */
     checkVoiceReady(): void;
+    /**
+     * Play a track. If no track is provided, plays the current queue track.
+     *
+     * FIX: Only sets `playing = true` after the REST call succeeds.
+     * In v1, state was set before the REST call, causing ghost playing state on failure.
+     */
     play(track?: Track, options?: {
         startTime?: number;
         endTime?: number;
         noReplace?: boolean;
     }): Promise<void>;
+    /**
+     * Pause or unpause playback.
+     *
+     * FIX: `playing` now reflects "has an active track" independently of pause state.
+     * A paused player is still "playing" (it has an active track, just paused).
+     */
     pause(state?: boolean): Promise<void>;
     resume(): Promise<void>;
     stop(): Promise<void>;
     skip(): Promise<Track | null>;
+    /**
+     * Play the previous track (from history).
+     * @returns The previous track, or null if no history exists
+     */
+    previous(): Promise<Track | null>;
+    /**
+     * Restart the currently playing track from the beginning.
+     */
+    replay(): Promise<void>;
     seek(position: number): Promise<void>;
     setVolume(volume: number): Promise<void>;
     setFilters(filters: FilterOptions): Promise<void>;
@@ -53,12 +97,39 @@ export declare class Player {
     setTremolo(enabled: boolean, frequency?: number, depth?: number): Promise<void>;
     setVibrato(enabled: boolean, frequency?: number, depth?: number): Promise<void>;
     setLowPass(enabled: boolean, smoothing?: number): Promise<void>;
+    /** Set playback speed (1.0 = normal, 2.0 = double speed) */
+    setSpeed(speed: number): Promise<void>;
+    /** Set playback pitch (1.0 = normal) */
+    setPitch(pitch: number): Promise<void>;
+    /**
+     * Add track(s) to the queue. If nothing is currently playing, plays immediately.
+     */
     add(tracks: Track | Track[], requester?: unknown): Promise<void>;
-    setLoop(mode: "none" | "track" | "queue"): void;
+    setLoop(mode: LoopMode): void;
     setAutoplay(enabled: boolean): void;
-    /** Move player to a different Lavalink node */
+    /**
+     * Move this player to a different Lavalink node.
+     *
+     * FIX: Now properly re-sends the voice state to the new node.
+     * In v1, the new node didn't know about the voice connection.
+     */
     moveToNode(node: Node): Promise<void>;
+    /** Move the bot to a different voice channel */
     move(channelId: string): Promise<void>;
+    /**
+     * Apply optimal audio settings based on the guild's boost tier.
+     * Automatically adjusts EQ and filters for best clarity at the available bitrate.
+     */
+    applyOptimalQuality(): Promise<void>;
+    /** Maximum audio quality — crystal clear, enhanced bass & treble */
+    setHighQuality(): Promise<void>;
+    /** Studio quality — flat, neutral, most accurate */
+    setStudioQuality(): Promise<void>;
+    /** Concert hall effect — scaled for boost tier */
+    setConcertHall(): Promise<void>;
+    /**
+     * Destroy this player and clean up all resources.
+     */
     destroy(): Promise<void>;
 }
 //# sourceMappingURL=Player.d.ts.map

package/dist/Player.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Player.d.ts","sourceRoot":"","sources":["../src/Player.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAc,aAAa,EAAE,MAAM,SAAS,CAAC;AAE/E,qBAAa,MAAM;IACjB,SAAgB,OAAO,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,IAAI,CAAC;IAClB,SAAgB,KAAK,EAAE,KAAK,CAAC;IAG7B,SAAgB,OAAO,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;IAGvB,KAAK,EAAE,WAAW,CAA4B;IAC9C,OAAO,EAAE,OAAO,CAAS;IACzB,MAAM,EAAE,OAAO,CAAS;IACxB,QAAQ,EAAE,MAAM,CAAK;IACrB,IAAI,EAAE,MAAM,CAAM;IAClB,WAAW,EAAE,MAAM,CAAc;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAU;IAG1C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;IAChC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAQ;IACjC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAQ;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAGlB,OAAO,EAAE,aAAa,CAAM;IAGnC,SAAgB,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAa;IAGhD,QAAQ,EAAE,OAAO,CAAS;gBAErB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa;IAkB/D,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,kCAAkC;IAClC,IAAI,YAAY,IAAI,MAAM,CAGzB;IAIM,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,IAAI;IAOtF,eAAe,IAAI,IAAI;IAyBjB,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA8B3G,KAAK,CAAC,KAAK,GAAE,OAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAU3C,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAEvB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAYrB,IAAI,IAAI,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAW7B,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAcrC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYxC,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBjD,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAW7B,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAWjF,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7C,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7C,KAAK,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAItC,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAM3C,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,SAAM,EAAE,KAAK,SAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzE,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,SAAM,EAAE,KAAK,SAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzE,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,SAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7D,GAAG,CAAC,MAAM,EAAE,KAAK,GAAG,KAAK,EAAE,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAetE,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,IAAI;IAI/C,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAM1C,+CAA+C;IAClC,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBrC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOtC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAYtC"}
+{"version":3,"file":"Player.d.ts","sourceRoot":"","sources":["../src/Player.ts"],"names":[],"mappings":"AAAA,sEAAsE;AAEtE,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,WAAW,EAAY,MAAM,aAAa,CAAC;AAEpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAExF;;;;;;;;;;;GAWG;AACH,qBAAa,MAAM;IACjB,SAAgB,OAAO,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,IAAI,CAAC;IAClB,SAAgB,KAAK,EAAE,KAAK,CAAC;IAE7B,SAAgB,OAAO,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,KAAK,EAAE,WAAW,CAA4B;IAC9C,OAAO,UAAS;IAChB,MAAM,UAAS;IACf,QAAQ,SAAK;IACb,IAAI,SAAM;IACV,WAAW,EAAE,MAAM,CAAc;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,CAAU;IACxB,QAAQ,UAAS;IAEjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;IAChC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAQ;IACjC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAQ;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAElB,OAAO,EAAE,aAAa,CAAM;IACnC,SAAgB,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAa;gBAE3C,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa;IAmB/D,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,MAAM,CAIzB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,SAAS,CAEzB;IAIM,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,IAAI;IAY7F;;OAEG;IACI,eAAe,IAAI,IAAI;IAkC9B;;;;;OAKG;IACU,IAAI,CACf,KAAK,CAAC,EAAE,KAAK,EACb,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GACtE,OAAO,CAAC,IAAI,CAAC;IAoChB;;;;;OAKG;IACU,KAAK,CAAC,KAAK,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAUlC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAYrB,IAAI,IAAI,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAW1C;;;OAGG;IACU,QAAQ,IAAI,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAe9C;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAOvB,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBrC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBxC,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBjD,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAW7B,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BjF,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C,KAAK,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAMtC,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ3C,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,SAAM,EAAE,KAAK,SAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYzE,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,SAAM,EAAE,KAAK,SAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYzE,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,SAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAO1E,4DAA4D;IAC/C,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUnD,wCAAwC;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYnD;;OAEG;IACU,GAAG,CAAC,MAAM,EAAE,KAAK,GAAG,KAAK,EAAE,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBtE,OAAO,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAI7B,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAM1C;;;;;OAKG;IACU,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BlD,gDAAgD;IACnC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOnD;;;OAGG;IACU,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IASjD,oEAAoE;IACvD,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IA0B5C,oDAAoD;IACvC,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAO9C,kDAAkD;IACrC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IA4B5C;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAsBtC"}