magmastream 2.5.16 → 2.6.0-beta.1

package/dist/index.d.ts

@@ -278,6 +278,19 @@ declare class Player {
      * @param volume
      */
     setVolume(volume: number): this;
+    /**
+     * Sets the sponsorblock for the player.
+     * @param segments
+     */
+    setSponsorBlock(segments?: SponsorBlockSegment[]): Promise<void>;
+    /**
+     * Gets the sponsorblock for the player.
+     */
+    getSponsorBlock(): Promise<SponsorBlockSegment[]>;
+    /**
+     * Deletes the sponsorblock for the player.
+     */
+    deleteSponsorBlock(): Promise<void>;
     /**
      * Sets the track repeat.
      * @param repeat
@@ -422,6 +435,7 @@ declare class Rest {
     get(endpoint: string): Promise<unknown>;
     patch(endpoint: string, body: unknown): Promise<unknown>;
     post(endpoint: string, body: unknown): Promise<unknown>;
+    put(endpoint: string, body: unknown): Promise<unknown>;
     delete(endpoint: string): Promise<unknown>;
 }
 interface playOptions {
@@ -454,6 +468,8 @@ interface playOptions {
     };
 }
 
+declare const validSponsorBlocks: string[];
+type SponsorBlockSegment = "sponsor" | "selfpromo" | "interaction" | "intro" | "outro" | "preview" | "music_offtopic" | "filler";
 declare class Node {
     options: NodeOptions;
     /** The socket for the node. */
@@ -468,7 +484,8 @@ declare class Node {
     private static _manager;
     private reconnectTimeout?;
     private reconnectAttempts;
-    info: LavalinkInfo;
+    /** Actual Lavalink information of the node. */
+    info: LavalinkInfo | null;
     /** Returns if connected to the Node. */
     get connected(): boolean;
     /** Returns the address for this node. */
@@ -503,6 +520,36 @@ declare class Node {
     protected trackStuck(player: Player, track: Track, payload: TrackStuckEvent): void;
     protected trackError(player: Player, track: Track | UnresolvedTrack, payload: TrackExceptionEvent): void;
     protected socketClosed(player: Player, payload: WebSocketClosedEvent): void;
+    private SponsorBlockSegmentLoaded;
+    private SponsorBlockSegmentSkipped;
+    private SponsorBlockChaptersLoaded;
+    private SponsorBlockChapterStarted;
+    fetchInfo(): Promise<LavalinkInfo>;
+    getSponsorBlock(player: Player): Promise<SponsorBlockSegment[]>;
+    /**
+     * Set the current sponsorblocks for the sponsorblock plugin
+     * @param player passthrough the player
+     * @returns void
+     *
+     * @example
+     * ```ts
+     * // use it on the player via player.setSponsorBlock();
+     * const sponsorBlockSegments = await player.node.setSponsorBlock(player, ["sponsor", "selfpromo"]);
+     * ```
+     */
+    setSponsorBlock(player: Player, segments?: SponsorBlockSegment[]): Promise<void>;
+    /**
+     * Delete the sponsorblock plugins
+     * @param player passthrough the player
+     * @returns void
+     *
+     * @example
+     * ```ts
+     * // use it on the player via player.deleteSponsorBlock();
+     * const sponsorBlockSegments = await player.node.deleteSponsorBlock(player);
+     * ```
+     */
+    deleteSponsorBlock(player: Player): Promise<void>;
 }
 interface NodeOptions {
     /** The host for the node. */
@@ -656,8 +703,10 @@ interface UnresolvedQuery {
 type Sizes = "0" | "1" | "2" | "3" | "default" | "mqdefault" | "hqdefault" | "maxresdefault";
 type LoadType = "track" | "playlist" | "search" | "empty" | "error";
 type State = "CONNECTED" | "CONNECTING" | "DISCONNECTED" | "DISCONNECTING" | "DESTROYING";
-type PlayerEvents = TrackStartEvent | TrackEndEvent | TrackStuckEvent | TrackExceptionEvent | WebSocketClosedEvent;
-type PlayerEventType = "TrackStartEvent" | "TrackEndEvent" | "TrackExceptionEvent" | "TrackStuckEvent" | "WebSocketClosedEvent";
+type SponsorBlockSegmentEvents = SponsorBlockSegmentSkipped | SponsorBlockSegmentsLoaded | SponsorBlockChapterStarted | SponsorBlockChaptersLoaded;
+type SponsorBlockSegmentEventType = "SegmentSkipped" | "SegmentsLoaded" | "ChapterStarted" | "ChaptersLoaded";
+type PlayerEvents = TrackStartEvent | TrackEndEvent | TrackStuckEvent | TrackExceptionEvent | WebSocketClosedEvent | SponsorBlockSegmentEvents;
+type PlayerEventType = "TrackStartEvent" | "TrackEndEvent" | "TrackExceptionEvent" | "TrackStuckEvent" | "WebSocketClosedEvent" | "SegmentSkipped" | "SegmentsLoaded" | "ChaptersLoaded" | "ChapterStarted";
 type TrackEndReason = "finished" | "loadFailed" | "stopped" | "replaced" | "cleanup";
 type Severity = "common" | "suspicious" | "fault";
 interface TrackData {
@@ -746,6 +795,44 @@ interface WebSocketClosedEvent extends PlayerEvent {
     reason: string;
     byRemote: boolean;
 }
+interface SponsorBlockSegmentsLoaded extends PlayerEvent {
+    type: "SegmentsLoaded";
+    segments: {
+        category: string;
+        start: number;
+        end: number;
+    }[];
+}
+interface SponsorBlockSegmentSkipped extends PlayerEvent {
+    type: "SegmentSkipped";
+    segment: {
+        category: string;
+        start: number;
+        end: number;
+    };
+}
+interface SponsorBlockChapterStarted extends PlayerEvent {
+    type: "ChapterStarted";
+    /** The chapter which started */
+    chapter: {
+        /** The name of the chapter */
+        name: string;
+        start: number;
+        end: number;
+        duration: number;
+    };
+}
+interface SponsorBlockChaptersLoaded extends PlayerEvent {
+    type: "ChaptersLoaded";
+    /** All chapters loaded */
+    chapters: {
+        /** The name of the chapter */
+        name: string;
+        start: number;
+        end: number;
+        duration: number;
+    }[];
+}
 interface PlayerUpdate {
     op: "playerUpdate";
     /** The guild id of the player. */
@@ -865,8 +952,6 @@ interface ManagerOptions {
     clientId?: string;
     /** Value to use for the `Client-Name` header. */
     clientName?: string;
-    /** The shard count. */
-    shards?: number;
     /** A array of plugins to use. */
     plugins?: Plugin[];
     /** Whether players should automatically play the next song. */
@@ -943,6 +1028,10 @@ interface ManagerEvents {
     trackEnd: [player: Player, track: Track, payload: TrackEndEvent];
     trackStuck: [player: Player, track: Track, payload: TrackStuckEvent];
     trackError: [player: Player, track: Track | UnresolvedTrack, payload: TrackExceptionEvent];
+    SegmentsLoaded: [player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockSegmentsLoaded];
+    SegmentSkipped: [player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockSegmentSkipped];
+    ChapterStarted: [player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockChapterStarted];
+    ChaptersLoaded: [player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockChaptersLoaded];
 }
 
-export { type CPUStats, type EqualizerBand, type Exception, type Extendable, type FrameStats, type LavalinkInfo, type LavalinkResponse, type LoadType, Manager, type ManagerEvents, type ManagerOptions, type MemoryStats, Node, type NodeMessage, type NodeOptions, type NodeStats, type Payload, type PlayOptions, Player, type PlayerEvent, type PlayerEventType, type PlayerEvents, type PlayerOptions, type PlayerUpdate, type PlaylistData, type PlaylistRawData, Plugin, Queue, type SearchPlatform, type SearchQuery, type SearchResult, type Severity, type Sizes, type State, Structure, type Track, type TrackData, type TrackDataInfo, type TrackEndEvent, type TrackEndReason, type TrackExceptionEvent, type TrackPluginInfo, type TrackSourceName, type TrackStartEvent, type TrackStuckEvent, TrackUtils, type UnresolvedQuery, type UnresolvedTrack, type VoicePacket, type VoiceServer, type VoiceState, type WebSocketClosedEvent };
+export { type CPUStats, type EqualizerBand, type Exception, type Extendable, type FrameStats, type LavalinkInfo, type LavalinkResponse, type LoadType, Manager, type ManagerEvents, type ManagerOptions, type MemoryStats, Node, type NodeMessage, type NodeOptions, type NodeStats, type Payload, type PlayOptions, Player, type PlayerEvent, type PlayerEventType, type PlayerEvents, type PlayerOptions, type PlayerUpdate, type PlaylistData, type PlaylistRawData, Plugin, Queue, type SearchPlatform, type SearchQuery, type SearchResult, type Severity, type Sizes, type SponsorBlockChapterStarted, type SponsorBlockChaptersLoaded, type SponsorBlockSegment, type SponsorBlockSegmentEventType, type SponsorBlockSegmentEvents, type SponsorBlockSegmentSkipped, type SponsorBlockSegmentsLoaded, type State, Structure, type Track, type TrackData, type TrackDataInfo, type TrackEndEvent, type TrackEndReason, type TrackExceptionEvent, type TrackPluginInfo, type TrackSourceName, type TrackStartEvent, type TrackStuckEvent, TrackUtils, type UnresolvedQuery, type UnresolvedTrack, type VoicePacket, type VoiceServer, type VoiceState, type WebSocketClosedEvent, validSponsorBlocks };

package/dist/structures/Manager.js

@@ -93,7 +93,6 @@ class Manager extends events_1.EventEmitter {
                     resumeTimeout: 1000,
                 },
             ],
-            shards: 1,
             autoPlay: true,
             usePriority: false,
             clientName: "Magmastream",

package/dist/structures/Node.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Node = void 0;
+exports.Node = exports.validSponsorBlocks = void 0;
 const tslib_1 = require("tslib");
 const Utils_1 = require("./Utils");
 const Rest_1 = require("./Rest");
 const nodeCheck_1 = tslib_1.__importDefault(require("../utils/nodeCheck"));
 const ws_1 = tslib_1.__importDefault(require("ws"));
+exports.validSponsorBlocks = ["sponsor", "selfpromo", "interaction", "intro", "outro", "preview", "music_offtopic", "filler"];
 class Node {
     options;
     /** The socket for the node. */
@@ -20,6 +21,7 @@ class Node {
     static _manager;
     reconnectTimeout;
     reconnectAttempts = 1;
+    /** Actual Lavalink information of the node. */
     info = null;
     /** Returns if connected to the Node. */
     get connected() {
@@ -91,12 +93,14 @@ class Node {
     connect() {
         if (this.connected)
             return;
-        const headers = Object.assign({
+        const headers = {
             Authorization: this.options.password,
-            "Num-Shards": String(this.manager.options.shards),
             "User-Id": this.manager.options.clientId,
             "Client-Name": this.manager.options.clientName,
-        });
+        };
+        if (this.sessionId) {
+            headers["Session-Id"] = this.sessionId;
+        }
         this.socket = new ws_1.default(`ws${this.options.secure ? "s" : ""}://${this.address}/v4/websocket`, { headers });
         this.socket.on("open", this.open.bind(this));
         this.socket.on("close", this.close.bind(this));
@@ -173,7 +177,7 @@ class Node {
             case "ready":
                 this.rest.setSessionId(payload.sessionId);
                 this.sessionId = payload.sessionId;
-                this.info = await this.rest.get("/v4/info");
+                this.info = await this.fetchInfo();
                 if (this.options.resumeStatus) {
                     this.rest.patch(`/v4/sessions/${this.sessionId}`, {
                         resuming: this.options.resumeStatus,
@@ -214,6 +218,18 @@ class Node {
             case "WebSocketClosedEvent":
                 this.socketClosed(player, payload);
                 break;
+            case "SegmentsLoaded":
+                this.SponsorBlockSegmentLoaded(player, player.queue.current, payload);
+                break;
+            case "SegmentSkipped":
+                this.SponsorBlockSegmentSkipped(player, player.queue.current, payload);
+                break;
+            case "ChaptersLoaded":
+                this.SponsorBlockChaptersLoaded(player, player.queue.current, payload);
+                break;
+            case "ChapterStarted":
+                this.SponsorBlockChapterStarted(player, player.queue.current, payload);
+                break;
             default:
                 error = new Error(`Node#event unknown event '${type}'.`);
                 this.manager.emit("nodeError", this, error);
@@ -394,5 +410,63 @@ class Node {
     socketClosed(player, payload) {
         this.manager.emit("socketClosed", player, payload);
     }
+    SponsorBlockSegmentLoaded(player, track, payload) {
+        return this.manager.emit("SegmentsLoaded", player, track, payload);
+    }
+    SponsorBlockSegmentSkipped(player, track, payload) {
+        return this.manager.emit("SegmentSkipped", player, track, payload);
+    }
+    SponsorBlockChaptersLoaded(player, track, payload) {
+        return this.manager.emit("ChaptersLoaded", player, track, payload);
+    }
+    SponsorBlockChapterStarted(player, track, payload) {
+        return this.manager.emit("ChapterStarted", player, track, payload);
+    }
+    async fetchInfo() {
+        return (await this.rest.get(`/v4/info`));
+    }
+    async getSponsorBlock(player) {
+        if (!this.info.plugins.some((plugin) => plugin.name === "sponsorblock-plugin"))
+            throw new RangeError(`there is no sponsorblock-plugin available in the lavalink node: ${this.options.identifier}`);
+        return (await this.rest.get(`/v4/sessions/${this.sessionId}/players/${player.guild}/sponsorblock/categories`));
+    }
+    /**
+     * Set the current sponsorblocks for the sponsorblock plugin
+     * @param player passthrough the player
+     * @returns void
+     *
+     * @example
+     * ```ts
+     * // use it on the player via player.setSponsorBlock();
+     * const sponsorBlockSegments = await player.node.setSponsorBlock(player, ["sponsor", "selfpromo"]);
+     * ```
+     */
+    async setSponsorBlock(player, segments = ["sponsor", "selfpromo"]) {
+        if (!this.info.plugins.some((plugin) => plugin.name === "sponsorblock-plugin"))
+            throw new RangeError(`there is no sponsorblock-plugin available in the lavalink node: ${this.options.identifier}`);
+        if (!segments.length)
+            throw new RangeError("No Segments provided. Did you mean to use 'deleteSponsorBlock'?");
+        if (segments.some((v) => !exports.validSponsorBlocks.includes(v.toLowerCase())))
+            throw new SyntaxError(`You provided a sponsorblock which isn't valid, valid ones are: ${exports.validSponsorBlocks.map((v) => `'${v}'`).join(", ")}`);
+        await this.rest.put(`/v4/sessions/${this.sessionId}/players/${player.guild}/sponsorblock/categories`, JSON.stringify(segments.map((v) => v.toLowerCase())));
+        return;
+    }
+    /**
+     * Delete the sponsorblock plugins
+     * @param player passthrough the player
+     * @returns void
+     *
+     * @example
+     * ```ts
+     * // use it on the player via player.deleteSponsorBlock();
+     * const sponsorBlockSegments = await player.node.deleteSponsorBlock(player);
+     * ```
+     */
+    async deleteSponsorBlock(player) {
+        if (!this.info.plugins.some((plugin) => plugin.name === "sponsorblock-plugin"))
+            throw new RangeError(`there is no sponsorblock-plugin available in the lavalink node: ${this.options.identifier}`);
+        await this.rest.delete(`/v4/sessions/${this.sessionId}/players/${player.guild}/sponsorblock/categories`);
+        return;
+    }
 }
 exports.Node = Node;

package/dist/structures/Player.js

@@ -329,6 +329,25 @@ class Player {
         this.manager.emit("playerStateUpdate", oldPlayer, this);
         return this;
     }
+    /**
+     * Sets the sponsorblock for the player.
+     * @param segments
+     */
+    async setSponsorBlock(segments = ["sponsor", "selfpromo"]) {
+        return this.node.setSponsorBlock(this, segments);
+    }
+    /**
+     * Gets the sponsorblock for the player.
+     */
+    async getSponsorBlock() {
+        return this.node.getSponsorBlock(this);
+    }
+    /**
+     * Deletes the sponsorblock for the player.
+     */
+    async deleteSponsorBlock() {
+        return this.node.deleteSponsorBlock(this);
+    }
     /**
      * Sets the track repeat.
      * @param repeat

package/dist/structures/Rest.js

@@ -55,7 +55,10 @@ class Rest {
             return response.data;
         }
         catch (error) {
-            if (error?.response?.status === 404) {
+            if (error?.response.data.message === "Guild not found") {
+                return [];
+            }
+            else if (error?.response?.status === 404) {
                 this.node.destroy();
                 this.node.manager.createNode(this.node.options).connect();
             }
@@ -74,6 +77,10 @@ class Rest {
     async post(endpoint, body) {
         return await this.request("POST", endpoint, body);
     }
+    /* Sends a PUT request to the specified endpoint and returns the response data. */
+    async put(endpoint, body) {
+        return await this.request("PUT", endpoint, body);
+    }
     /* Sends a DELETE request to the specified endpoint and returns the response data. */
     async delete(endpoint) {
         return await this.request("DELETE", endpoint);

package/dist/utils/managerCheck.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 function managerCheck(options) {
     if (!options)
         throw new TypeError("ManagerOptions must not be empty.");
-    const { autoPlay, clientId, clientName, defaultSearchPlatform, nodes, plugins, send, shards, trackPartial, usePriority, useNode, replaceYouTubeCredentials } = options;
+    const { autoPlay, clientId, clientName, defaultSearchPlatform, nodes, plugins, send, trackPartial, usePriority, useNode, replaceYouTubeCredentials } = options;
     if (typeof autoPlay !== "undefined" && typeof autoPlay !== "boolean") {
         throw new TypeError('Manager option "autoPlay" must be a boolean.');
     }
@@ -25,9 +25,6 @@ function managerCheck(options) {
     if (typeof send !== "function") {
         throw new TypeError('Manager option "send" must be present and a function.');
     }
-    if (typeof shards !== "undefined" && typeof shards !== "number") {
-        throw new TypeError('Manager option "shards" must be a number.');
-    }
     if (typeof trackPartial !== "undefined" && !Array.isArray(trackPartial)) {
         throw new TypeError('Manager option "trackPartial" must be a string array.');
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "magmastream",
-	"version": "2.5.16",
+	"version": "2.6.0-beta.1",
 	"description": "A user-friendly Lavalink client designed for NodeJS.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",