Added Sponsor Block Events & Removed Shards from manager since it doe…

…s nothing.

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",

src/structures/Manager.ts

@@ -14,13 +14,15 @@ import {
 	WebSocketClosedEvent,
 } from "./Utils";
 import { Collection } from "@discordjs/collection";
+import { SponsorBlockChapterStarted, SponsorBlockChaptersLoaded, SponsorBlockSegmentSkipped, SponsorBlockSegmentsLoaded } from "./Utils";
 import { EventEmitter } from "events";
 import { Node, NodeOptions } from "./Node";
 import { Player, PlayerOptions, Track, UnresolvedTrack } from "./Player";
 import { VoiceState } from "..";
 import managerCheck from "../utils/managerCheck";
 import { ClientUser, User } from "discord.js";
 import { blockedWords } from "../config/blockedWords";
+
 /**
  * The main hub for interacting with Lavalink and using Magmastream,
  */
@@ -120,7 +122,6 @@ export class Manager extends EventEmitter {
 					resumeTimeout: 1000,
 				},
 			],
-			shards: 1,
 			autoPlay: true,
 			usePriority: false,
 			clientName: "Magmastream",
@@ -476,8 +477,6 @@ export 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. */
@@ -558,4 +557,8 @@ export 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];
 }

src/structures/Node.ts

@@ -8,13 +8,20 @@ import {
 	TrackStuckEvent,
 	TrackUtils,
 	WebSocketClosedEvent,
+	SponsorBlockChapterStarted,
+	SponsorBlockChaptersLoaded,
+	SponsorBlockSegmentsLoaded,
+	SponsorBlockSegmentSkipped,
 } from "./Utils";
 import { LavalinkResponse, Manager, PlaylistRawData } from "./Manager";
 import { Player, Track, UnresolvedTrack } from "./Player";
 import { Rest } from "./Rest";
 import nodeCheck from "../utils/nodeCheck";
 import WebSocket from "ws";
 
+export const validSponsorBlocks = ["sponsor", "selfpromo", "interaction", "intro", "outro", "preview", "music_offtopic", "filler"];
+export type SponsorBlockSegment = "sponsor" | "selfpromo" | "interaction" | "intro" | "outro" | "preview" | "music_offtopic" | "filler";
+
 export class Node {
 	/** The socket for the node. */
 	public socket: WebSocket | null = null;
@@ -30,7 +37,8 @@ export class Node {
 	private reconnectTimeout?: NodeJS.Timeout;
 	private reconnectAttempts = 1;
 
-	public info: LavalinkInfo = null;
+	/** Actual Lavalink information of the node. */
+	public info: LavalinkInfo | null = null;
 
 	/** Returns if connected to the Node. */
 	public get connected(): boolean {
@@ -108,12 +116,15 @@ export class Node {
 	public connect(): void {
 		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 WebSocket(`ws${this.options.secure ? "s" : ""}://${this.address}/v4/websocket`, { headers });
 		this.socket.on("open", this.open.bind(this));
@@ -197,7 +208,7 @@ export class Node {
 			case "ready":
 				this.rest.setSessionId(payload.sessionId);
 				this.sessionId = payload.sessionId;
-				this.info = <LavalinkInfo>await this.rest.get("/v4/info");
+				this.info = await this.fetchInfo();
 
 				if (this.options.resumeStatus) {
 					this.rest.patch(`/v4/sessions/${this.sessionId}`, {
@@ -247,6 +258,19 @@ export class Node {
 				this.socketClosed(player, payload);
 				break;
 
+			case "SegmentsLoaded":
+				this.SponsorBlockSegmentLoaded(player, player.queue.current as Track, payload);
+				break;
+			case "SegmentSkipped":
+				this.SponsorBlockSegmentSkipped(player, player.queue.current as Track, payload);
+				break;
+			case "ChaptersLoaded":
+				this.SponsorBlockChaptersLoaded(player, player.queue.current as Track, payload);
+				break;
+			case "ChapterStarted":
+				this.SponsorBlockChapterStarted(player, player.queue.current as Track, payload);
+				break;
+
 			default:
 				error = new Error(`Node#event unknown event '${type}'.`);
 				this.manager.emit("nodeError", this, error);
@@ -450,6 +474,75 @@ export class Node {
 	protected socketClosed(player: Player, payload: WebSocketClosedEvent): void {
 		this.manager.emit("socketClosed", player, payload);
 	}
+
+	private SponsorBlockSegmentLoaded(player: Player, track: Track, payload: SponsorBlockSegmentsLoaded) {
+		return this.manager.emit("SegmentsLoaded", player, track, payload);
+	}
+
+	private SponsorBlockSegmentSkipped(player: Player, track: Track, payload: SponsorBlockSegmentSkipped) {
+		return this.manager.emit("SegmentSkipped", player, track, payload);
+	}
+
+	private SponsorBlockChaptersLoaded(player: Player, track: Track, payload: SponsorBlockChaptersLoaded) {
+		return this.manager.emit("ChaptersLoaded", player, track, payload);
+	}
+
+	private SponsorBlockChapterStarted(player: Player, track: Track, payload: SponsorBlockChapterStarted) {
+		return this.manager.emit("ChapterStarted", player, track, payload);
+	}
+	public async fetchInfo() {
+		return (await this.rest.get(`/v4/info`)) as LavalinkInfo;
+	}
+
+	public async getSponsorBlock(player: Player): Promise<SponsorBlockSegment[]> {
+		if (!this.info.plugins.some((plugin: { name: string }) => 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`)) as 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"]);
+	 * ```
+	 */
+	public async setSponsorBlock(player: Player, segments: SponsorBlockSegment[] = ["sponsor", "selfpromo"]): Promise<void> {
+		if (!this.info.plugins.some((plugin: { name: string }) => 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) => !validSponsorBlocks.includes(v.toLowerCase())))
+			throw new SyntaxError(`You provided a sponsorblock which isn't valid, valid ones are: ${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);
+	 * ```
+	 */
+	public async deleteSponsorBlock(player: Player): Promise<void> {
+		if (!this.info.plugins.some((plugin: { name: string }) => 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;
+	}
 }
 
 export interface NodeOptions {

src/structures/Player.ts

@@ -1,6 +1,6 @@
 import { Filters } from "./Filters";
 import { LavalinkResponse, Manager, PlaylistRawData, SearchQuery, SearchResult } from "./Manager";
-import { LavalinkInfo, Node } from "./Node";
+import { LavalinkInfo, Node, SponsorBlockSegment } from "./Node";
 import { Queue } from "./Queue";
 import { Sizes, State, Structure, TrackSourceName, TrackUtils, VoiceState } from "./Utils";
 import * as _ from "lodash";
@@ -404,6 +404,28 @@ export class Player {
 		return this;
 	}
 
+	/**
+	 * Sets the sponsorblock for the player.
+	 * @param segments
+	 */
+	public async setSponsorBlock(segments: SponsorBlockSegment[] = ["sponsor", "selfpromo"]) {
+		return this.node.setSponsorBlock(this, segments);
+	}
+
+	/**
+	 * Gets the sponsorblock for the player.
+	 */
+	public async getSponsorBlock() {
+		return this.node.getSponsorBlock(this);
+	}
+
+	/**
+	 * Deletes the sponsorblock for the player.
+	 */
+	public async deleteSponsorBlock() {
+		return this.node.deleteSponsorBlock(this);
+	}
+
 	/**
 	 * Sets the track repeat.
 	 * @param repeat
@@ -514,14 +536,13 @@ export class Player {
 			this.queue.splice(0, amount - 1);
 		}
 
-
 		this.node.rest.updatePlayer({
 			guildId: this.guild,
 			data: {
 				encodedTrack: null,
 			},
 		});
-		
+
 		this.manager.emit("playerStateUpdate", oldPlayer, this);
 		return this;
 	}
@@ -556,7 +577,7 @@ export class Player {
 		const oldPlayer = { ...this };
 		this.queue.unshift(this.queue.previous);
 		this.stop();
-		
+
 		this.manager.emit("playerStateUpdate", oldPlayer, this);
 		return this;
 	}

src/structures/Rest.ts

@@ -59,7 +59,9 @@ export class Rest {
 			const response = await axios(config);
 			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();
 			}
@@ -83,6 +85,11 @@ export class Rest {
 		return await this.request("POST", endpoint, body);
 	}
 
+	/* Sends a PUT request to the specified endpoint and returns the response data. */
+	public async put(endpoint: string, body: unknown): Promise<unknown> {
+		return await this.request("PUT", endpoint, body);
+	}
+
 	/* Sends a DELETE request to the specified endpoint and returns the response data. */
 	public async delete(endpoint: string): Promise<unknown> {
 		return await this.request("DELETE", endpoint);

src/structures/Utils.ts

@@ -229,9 +229,22 @@ export type LoadType = "track" | "playlist" | "search" | "empty" | "error";
 
 export type State = "CONNECTED" | "CONNECTING" | "DISCONNECTED" | "DISCONNECTING" | "DESTROYING";
 
-export type PlayerEvents = TrackStartEvent | TrackEndEvent | TrackStuckEvent | TrackExceptionEvent | WebSocketClosedEvent;
+export type SponsorBlockSegmentEvents = SponsorBlockSegmentSkipped | SponsorBlockSegmentsLoaded | SponsorBlockChapterStarted | SponsorBlockChaptersLoaded;
 
-export type PlayerEventType = "TrackStartEvent" | "TrackEndEvent" | "TrackExceptionEvent" | "TrackStuckEvent" | "WebSocketClosedEvent";
+export type SponsorBlockSegmentEventType = "SegmentSkipped" | "SegmentsLoaded" | "ChapterStarted" | "ChaptersLoaded";
+
+export type PlayerEvents = TrackStartEvent | TrackEndEvent | TrackStuckEvent | TrackExceptionEvent | WebSocketClosedEvent | SponsorBlockSegmentEvents;
+
+export type PlayerEventType =
+	| "TrackStartEvent"
+	| "TrackEndEvent"
+	| "TrackExceptionEvent"
+	| "TrackStuckEvent"
+	| "WebSocketClosedEvent"
+	| "SegmentSkipped"
+	| "SegmentsLoaded"
+	| "ChaptersLoaded"
+	| "ChapterStarted";
 
 export type TrackEndReason = "finished" | "loadFailed" | "stopped" | "replaced" | "cleanup";
 
@@ -339,6 +352,61 @@ export interface WebSocketClosedEvent extends PlayerEvent {
 	byRemote: boolean;
 }
 
+export interface SponsorBlockSegmentsLoaded extends PlayerEvent {
+	type: "SegmentsLoaded";
+	/* The loaded segments */
+	segments: {
+		/* The category name */
+		category: string;
+		/* In milliseconds */
+		start: number;
+		/* In milliseconds */
+		end: number;
+	}[];
+}
+export interface SponsorBlockSegmentSkipped extends PlayerEvent {
+	type: "SegmentSkipped";
+	/* The skipped segment*/
+	segment: {
+		/* The category name */
+		category: string;
+		/* In milliseconds */
+		start: number;
+		/* In milliseconds */
+		end: number;
+	};
+}
+
+export interface SponsorBlockChapterStarted extends PlayerEvent {
+	type: "ChapterStarted";
+	/** The chapter which started */
+	chapter: {
+		/** The name of the chapter */
+		name: string;
+		/* In milliseconds */
+		start: number;
+		/* In milliseconds */
+		end: number;
+		/* In milliseconds */
+		duration: number;
+	};
+}
+
+export interface SponsorBlockChaptersLoaded extends PlayerEvent {
+	type: "ChaptersLoaded";
+	/** All chapters loaded */
+	chapters: {
+		/** The name of the chapter */
+		name: string;
+		/* In milliseconds */
+		start: number;
+		/* In milliseconds */
+		end: number;
+		/* In milliseconds */
+		duration: number;
+	}[];
+}
+
 export interface PlayerUpdate {
 	op: "playerUpdate";
 	/** The guild id of the player. */