lavalink-client 2.3.5 → 2.4.0

package/README.md

@@ -13,7 +13,7 @@ Easy, flexible and feature-rich lavalink@v4 Client. Both for Beginners and Profi
     <a href="https://www.npmjs.com/package/lavalink-client">
       <img src="https://img.shields.io/npm/dt/lavalink-client.svg?maxAge=3600&style=for-the-badge&logo=npm&logoColor=red" alt="NPM downloads" />
     </a>
-    <a href="https://lc4.gitbook.io/lavalink-client/">
+    <a href="https://tomato6966.github.io/lavalink-client/">
       <img src="https://img.shields.io/badge/Documation-%230288D1.svg?style=for-the-badge&logo=gitbook&logoColor=white" alt="Get Started Now">
     </a>
   </p>
@@ -24,7 +24,7 @@ Easy, flexible and feature-rich lavalink@v4 Client. Both for Beginners and Profi
 
 # Install
 
-Latest stable Version: **`v2.1.3`**
+Latest stable Version: **`v2.4.0`**
 
 <details><summary>👉 via NPM</summary>
 
@@ -36,7 +36,7 @@ npm install --save lavalink-client
 Dev Version: (Current)
 
 ```bash
-npm install tomato6966/lavalink-client
+npm install --save  tomato6966/lavalink-client
 ```
 
 </details>
@@ -57,9 +57,10 @@ yarn add tomato6966/lavalink-client
 
 # Documentation
 
-Check out the [Documentation](https://lc4.gitbook.io/lavalink-client) | or the [TSDocumentation](https://tomato6966.github.io/lavalink-client/) for **Examples**, and **__detailled__ Docs**, and to figure out **how to get started**. *note: it's not fully done yet (see the docs)*
-
-- __**INFO Note**__: Please use the **[TSDocumentation (auto generated, folder `/tsDocs`)](https://tomato6966.github.io/lavalink-client/)** to get the entire information of lavalink-client, *I don't have time to update the [custom written gitbook-documentation](https://lc4.gitbook.io/lavalink-client) (folder `/docs`, feel free to update it)*
+Check out the [Documentation](https://tomato6966.github.io/lavalink-client/)
+- See all [Manager-Events, e.g. for Track / player and general errors / logs](https://tomato6966.github.io/lavalink-client/extra/manager-events)
+- See all [NodeManager-Events e.g. for Node Errors / logs](https://tomato6966.github.io/lavalink-client/extra/node-events)
+- See the Guide on [How to do resuming](https://tomato6966.github.io/lavalink-client/extra/resuming)
 
 # Used in:
 
@@ -722,3 +723,69 @@ if(previousTrack) {
 - FIXED autoplay not working :: Accidentally added an invalid if statement, which made autoplay not working anymore (during the if statement  to not prevent autoplay spam)
 - Added a new AutoplayExecution Debug Log
 - Added more samples to the Testbot related configuration
+
+
+## **Version 2.3.6**
+- Added Lyrics Support:
+  - New Player Functions:
+    - **` const lyrics = await player.getCurrentLyrics(false); `** -> *Get lyrics of current playing track*
+    - **` const lyrics = await player.getLyrics(track, true); `** -> *Get lyrics of a specific track with ignoring it's sources*
+    - **` player.subscribeLyrics(); `** -> *Subscribe this guild to retrieve "live lyrics" as the song is *playing
+    - **` player.unsubscribeLyrics(); `** -> *Unsubscribe from lyrics
+  - New Node Functions ( same as from player, just so you can access it without player too ):*
+    - **` const lyrics = await player.node.lyrics.getCurrent(player.guildId, false); `**
+    - **` const lyrics = await player.node.lyrics.get(track, true); `**
+    - **` player.node.lyrics.subscribe(player.guildId); `**
+    - **` player.node.lyrics.unsubscribe(player.guildId); `**
+  - New Manager Event sfor Lyrics:
+    - **` lavalink.on("LyricsLine", (player, track, lyricsLine) => {}); `**
+    - **` lavalink.on("LyricsFound", (player, track, data) => {}); `**
+    - **` lavalink.on("LyricsNotFound", (player, track, lyricsLine) => {}); `**
+
+
+## **Version 2.4.0**
+- Refactored a little the project folder Structure
+- Added PR Packages to install all commits / packages at once `https://pkg.pr.new/Tomato6966/lavalink-client`
+- Removed the dist folder, and added prepare Scripts
+- Added attributes for git linting
+- Removed the old (gitbook) documentation, and swapped it to a NEW TSDOC Themed Documentation via astro.dev and mdx
+- Added new player events:
+    - **`playerMuteChange`**** ➡️ **`(player, selfMuted, serverMuted) => {}`
+    *Triggered when the player's voice state related to muting changed*
+
+    - **`playerDeafChange`** ➡️ `(player, selfDeafed, serverDeafed) => {}`
+    *Triggered when the player's voice state related to deafing changed*
+
+    - **`playerSuppressChange`** ➡️ `(player, suppress) => {}`
+    *Triggered when the player's voice state related to suppressing changed*
+
+    - **`playerQueueEmptyStart`** ➡️ `(player, timeoutMs) => {}`
+    *Triggered when the queue empty handler started (the timeout)*
+
+    - **`playerQueueEmptyEnd`** ➡️ `(player) => {}`
+    *Triggered when the queue empty handler finished (successfully) and thus destroyed the player*
+
+    - **`playerQueueEmptyCancel`** ➡️ `(player) => {}`
+    *Triggered when the queue empty handler cancelled (e.g. because a new track got added)*
+
+    ~~- **`playerVoiceEmptyStart`** ➡️ `(player, timeoutMs) => {}`~~
+    ~~*Triggered when the voice empty handler started (the timeout)*~~
+    *Removed again because of memory overhall and not wanting to handle voice states*
+
+    ~~- **`playerVoiceEmptyEnd`** ➡️ `(player) => {}`~~
+    ~~*Triggered when the voice empty handler finished (successfully) and thus destroyed the player*~~
+    *Removed again because of memory overhall and not wanting to handle voice states*
+
+    ~~- **`playerVoiceEmptyCancel`** ➡️ `(player, userId) => {}`~~
+    ~~*Triggered when the voice empty handler cancelled (e.g. when a user rejoined)*~~
+    *Removed again because of memory overhall and not wanting to handle voice states*
+
+    - **`playerVoiceJoin`** ➡️ `(player, userId) => {}`~~
+    *Added instead of the playerVoiceEmpty handler, emitted when a user joins the player-vc while there is a player*
+    *Allows you to inmplement a custom playerVoiceEmpty handler*
+
+    - **`playerVoiceLeave`** ➡️ `(player, userId) => {}`~~
+    *Added instead of the playerVoiceEmpty handler, emitted when a user leaves (or. switches away) the player-vc while there is a player*
+    *Allows you to inmplement a custom playerVoiceEmpty handler*
+
+- Added the new events and configuration to the docs

package/dist/cjs/structures/Constants.d.ts

@@ -55,6 +55,10 @@ export declare enum DestroyReasons {
     TrackErrorMaxTracksErroredPerTime = "TrackErrorMaxTracksErroredPerTime",
     TrackStuckMaxTracksErroredPerTime = "TrackStuckMaxTracksErroredPerTime"
 }
+export declare enum DisconnectReasons {
+    Disconnected = "Disconnected",
+    DisconnectAllNodes = "DisconnectAllNodes"
+}
 export declare const validSponsorBlocks: string[];
 /**  The audio Outputs Data map declaration */
 export declare const audioOutputsData: Record<AudioOutputs, ChannelMixFilter>;

package/dist/cjs/structures/Constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EQList = exports.audioOutputsData = exports.validSponsorBlocks = exports.DestroyReasons = exports.DebugEvents = void 0;
+exports.EQList = exports.audioOutputsData = exports.validSponsorBlocks = exports.DisconnectReasons = exports.DestroyReasons = exports.DebugEvents = void 0;
 var DebugEvents;
 (function (DebugEvents) {
     DebugEvents["SetSponsorBlock"] = "SetSponsorBlock";
@@ -60,11 +60,16 @@ var DestroyReasons;
     DestroyReasons["TrackStuckMaxTracksErroredPerTime"] = "TrackStuckMaxTracksErroredPerTime";
 })(DestroyReasons || (exports.DestroyReasons = DestroyReasons = {}));
 ;
+var DisconnectReasons;
+(function (DisconnectReasons) {
+    DisconnectReasons["Disconnected"] = "Disconnected";
+    DisconnectReasons["DisconnectAllNodes"] = "DisconnectAllNodes";
+})(DisconnectReasons || (exports.DisconnectReasons = DisconnectReasons = {}));
 exports.validSponsorBlocks = ["sponsor", "selfpromo", "interaction", "intro", "outro", "preview", "music_offtopic", "filler"];
 /**  The audio Outputs Data map declaration */
 exports.audioOutputsData = {
     mono: {
-        leftToLeft: 0.5,
+        leftToLeft: 0.5, //each channel should in total 0 | 1, 0 === off, 1 === on, 0.5+0.5 === 1
         leftToRight: 0.5,
         rightToLeft: 0.5,
         rightToRight: 0.5,

package/dist/cjs/structures/Filters.d.ts

@@ -87,9 +87,33 @@ export declare class FilterManager {
      */
     toggleLowPass(smoothing?: number): Promise<boolean>;
     lavalinkLavaDspxPlugin: {
+        /**
+         * Enables / Disables the LowPass effect, (Optional: provide your Own Data)
+         * @param boostFactor
+         * @param cutoffFrequency
+         * @returns
+         */
         toggleLowPass: (boostFactor?: number, cutoffFrequency?: number) => Promise<boolean>;
+        /**
+         * Enables / Disables the HighPass effect, (Optional: provide your Own Data)
+         * @param boostFactor
+         * @param cutoffFrequency
+         * @returns
+         */
         toggleHighPass: (boostFactor?: number, cutoffFrequency?: number) => Promise<boolean>;
+        /**
+         * Enables / Disables the Normalization effect.
+         * @param {number} [maxAmplitude=0.75] - The maximum amplitude of the audio.
+         * @param {boolean} [adaptive=true] - Whether to use adaptive normalization or not.
+         * @returns {Promise<boolean>} - The state of the filter after execution.
+         */
         toggleNormalization: (maxAmplitude?: number, adaptive?: boolean) => Promise<boolean>;
+        /**
+         * Enables / Disables the Echo effect, IMPORTANT! Only works with the correct Lavalink Plugin installed. (Optional: provide your Own Data)
+         * @param {number} [decay=0.5] - The decay of the echo effect.
+         * @param {number} [echoLength=0.5] - The length of the echo effect.
+         * @returns {Promise<boolean>} - The state of the filter after execution.
+         */
         toggleEcho: (decay?: number, echoLength?: number) => Promise<boolean>;
     };
     lavalinkFilterPlugin: {

package/dist/cjs/structures/Filters.js

@@ -45,29 +45,29 @@ class FilterManager {
             filterWidth: 0
         },
         timescale: {
-            speed: 1,
-            pitch: 1,
+            speed: 1, // 0 = x
+            pitch: 1, // 0 = x
             rate: 1 // 0 = x
         },
         rotation: {
             rotationHz: 0
         },
         tremolo: {
-            frequency: 0,
+            frequency: 0, // 0 < x
             depth: 0 // 0 < x = 1
         },
         vibrato: {
-            frequency: 0,
+            frequency: 0, // 0 < x <= 14
             depth: 0 // 0 < x <= 1
         },
         pluginFilters: {
             "lavalink-filter-plugin": {
                 echo: {
-                    delay: 0,
+                    delay: 0, // in seconds
                     decay: 0 // 0 < 1
                 },
                 reverb: {
-                    delays: [],
+                    delays: [], // [0.037, 0.042, 0.048, 0.053]
                     gains: [] // [0.84, 0.83, 0.82, 0.81]
                 }
             },
@@ -231,8 +231,8 @@ class FilterManager {
                 filterWidth: 0
             },
             timescale: {
-                speed: 1,
-                pitch: 1,
+                speed: 1, // 0 = x
+                pitch: 1, // 0 = x
                 rate: 1 // 0 = x
             },
             pluginFilters: {
@@ -267,11 +267,11 @@ class FilterManager {
                 rotationHz: 0
             },
             tremolo: {
-                frequency: 0,
+                frequency: 0, // 0 < x
                 depth: 0 // 0 < x = 1
             },
             vibrato: {
-                frequency: 0,
+                frequency: 0, // 0 < x = 14
                 depth: 0 // 0 < x = 1
             },
             channelMix: Constants_1.audioOutputsData.stereo,
@@ -431,6 +431,12 @@ class FilterManager {
         return this.filters.lowPass;
     }
     lavalinkLavaDspxPlugin = {
+        /**
+         * Enables / Disables the LowPass effect, (Optional: provide your Own Data)
+         * @param boostFactor
+         * @param cutoffFrequency
+         * @returns
+         */
         toggleLowPass: async (boostFactor = 1.0, cutoffFrequency = 80) => {
             if (this.player.node.info && !this.player.node.info?.plugins?.find(v => v.name === "lavadspx-plugin"))
                 throw new Error("Node#Info#plugins does not include the lavadspx plugin");
@@ -455,6 +461,12 @@ class FilterManager {
             await this.applyPlayerFilters();
             return this.filters.lavalinkLavaDspxPlugin.lowPass;
         },
+        /**
+         * Enables / Disables the HighPass effect, (Optional: provide your Own Data)
+         * @param boostFactor
+         * @param cutoffFrequency
+         * @returns
+         */
         toggleHighPass: async (boostFactor = 1.0, cutoffFrequency = 80) => {
             if (this.player.node.info && !this.player.node.info?.plugins?.find(v => v.name === "lavadspx-plugin"))
                 throw new Error("Node#Info#plugins does not include the lavadspx plugin");
@@ -479,6 +491,12 @@ class FilterManager {
             await this.applyPlayerFilters();
             return this.filters.lavalinkLavaDspxPlugin.highPass;
         },
+        /**
+         * Enables / Disables the Normalization effect.
+         * @param {number} [maxAmplitude=0.75] - The maximum amplitude of the audio.
+         * @param {boolean} [adaptive=true] - Whether to use adaptive normalization or not.
+         * @returns {Promise<boolean>} - The state of the filter after execution.
+         */
         toggleNormalization: async (maxAmplitude = 0.75, adaptive = true) => {
             if (this.player.node.info && !this.player.node.info?.plugins?.find(v => v.name === "lavadspx-plugin"))
                 throw new Error("Node#Info#plugins does not include the lavadspx plugin");
@@ -503,6 +521,12 @@ class FilterManager {
             await this.applyPlayerFilters();
             return this.filters.lavalinkLavaDspxPlugin.normalization;
         },
+        /**
+         * Enables / Disables the Echo effect, IMPORTANT! Only works with the correct Lavalink Plugin installed. (Optional: provide your Own Data)
+         * @param {number} [decay=0.5] - The decay of the echo effect.
+         * @param {number} [echoLength=0.5] - The length of the echo effect.
+         * @returns {Promise<boolean>} - The state of the filter after execution.
+         */
         toggleEcho: async (decay = 0.5, echoLength = 0.5) => {
             if (this.player.node.info && !this.player.node.info?.plugins?.find(v => v.name === "lavadspx-plugin"))
                 throw new Error("Node#Info#plugins does not include the lavadspx plugin");

package/dist/cjs/structures/LavalinkManager.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from "events";
 import { NodeManager } from "./NodeManager.js";
 import { Player } from "./Player.js";
@@ -137,7 +136,7 @@ export declare class LavalinkManager extends EventEmitter {
      * ```
      * @returns
      */
-    getPlayer(guildId: string): Player;
+    getPlayer(guildId: string): Player | undefined;
     /**
      * Create a Music-Player. If a player exists, then it returns it before creating a new one
      * @param options
@@ -175,7 +174,7 @@ export declare class LavalinkManager extends EventEmitter {
      * // recommend to do it on the player tho: player.destroy("forcefully destroyed the player");
      * ```
      */
-    destroyPlayer(guildId: string, destroyReason?: string): Promise<Player>;
+    destroyPlayer(guildId: string, destroyReason?: string): Promise<void | Player>;
     /**
      * Delete's a player from the cache without destroying it on lavalink (only works when it's disconnected)
      * @param guildId
@@ -187,7 +186,7 @@ export declare class LavalinkManager extends EventEmitter {
      * // shouldn't be used except you know what you are doing.
      * ```
      */
-    deletePlayer(guildId: string): boolean;
+    deletePlayer(guildId: string): boolean | void;
     /**
      * Checks wether the the lib is useable based on if any node is connected
      *
@@ -213,7 +212,7 @@ export declare class LavalinkManager extends EventEmitter {
      * });
      * ```
      */
-    init(clientData: BotClientOptions): Promise<this>;
+    init(clientData: BotClientOptions): Promise<LavalinkManager>;
     /**
      * Sends voice data to the Lavalink server.
      * ! Without this the library won't work

package/dist/cjs/structures/LavalinkManager.js

@@ -92,9 +92,9 @@ class LavalinkManager extends events_1.EventEmitter {
                 volumeDecrementer: options?.playerOptions?.volumeDecrementer ?? 1,
                 requesterTransformer: options?.playerOptions?.requesterTransformer ?? null,
                 useUnresolvedData: options?.playerOptions?.useUnresolvedData ?? false,
-                minAutoPlayMs: options?.playerOptions?.minAutoPlayMs ?? 10000,
+                minAutoPlayMs: options?.playerOptions?.minAutoPlayMs ?? 10_000,
                 maxErrorsPerTime: {
-                    threshold: options?.playerOptions?.maxErrorsPerTime?.threshold ?? 35000,
+                    threshold: options?.playerOptions?.maxErrorsPerTime?.threshold ?? 35_000,
                     maxAmount: options?.playerOptions?.maxErrorsPerTime?.maxAmount ?? 3
                 }
             },
@@ -111,7 +111,7 @@ class LavalinkManager extends events_1.EventEmitter {
             },
             advancedOptions: {
                 enableDebugEvents: options?.advancedOptions?.enableDebugEvents ?? false,
-                maxFilterFixDuration: options?.advancedOptions?.maxFilterFixDuration ?? 600000,
+                maxFilterFixDuration: options?.advancedOptions?.maxFilterFixDuration ?? 600_000,
                 debugOptions: {
                     logCustomSearches: options?.advancedOptions?.debugOptions?.logCustomSearches ?? false,
                     noAudio: options?.advancedOptions?.debugOptions?.noAudio ?? false,
@@ -509,11 +509,16 @@ class LavalinkManager extends events_1.EventEmitter {
             }
             /* voice state update */
             if (update.user_id !== this.options?.client.id) {
-                this.emit("debug", Constants_1.DebugEvents.NoAudioDebug, {
-                    state: "warn",
-                    message: `voice update user is not equal to provided client id of the LavalinkManager.options.client.id :: user: "${update.user_id}" manager client id: "${this.options?.client.id}"`,
-                    functionLayer: "LavalinkManager > sendRawData()",
-                });
+                if (update.user_id && player.voiceChannelId) {
+                    this.emit(update.channel_id === player.voiceChannelId ? "playerVoiceJoin" : "playerVoiceLeave", player, update.user_id);
+                }
+                if (this.options?.advancedOptions?.enableDebugEvents) {
+                    this.emit("debug", Constants_1.DebugEvents.NoAudioDebug, {
+                        state: "warn",
+                        message: `voice update user is not equal to provided client id of the LavalinkManager.options.client.id :: user: "${update.user_id}" manager client id: "${this.options?.client.id}"`,
+                        functionLayer: "LavalinkManager > sendRawData()",
+                    });
+                }
                 if (this.options?.advancedOptions?.debugOptions?.noAudio === true)
                     console.debug("Lavalink-Client-Debug | NO-AUDIO [::] sendRawData function, voice update user is not equal to provided client id of the manageroptions#client#id", "user:", update.user_id, "manager client id:", this.options?.client.id);
                 return;
@@ -523,6 +528,22 @@ class LavalinkManager extends events_1.EventEmitter {
                     this.emit("playerMove", player, player.voiceChannelId, update.channel_id);
                 player.voice.sessionId = update.session_id;
                 player.voiceChannelId = update.channel_id;
+                const selfMuteChanged = typeof update.self_mute === "boolean" && player.voiceState.selfMute !== update.self_mute;
+                const serverMuteChanged = typeof update.mute === "boolean" && player.voiceState.serverMute !== update.mute;
+                const selfDeafChanged = typeof update.self_deaf === "boolean" && player.voiceState.selfDeaf !== update.self_deaf;
+                const serverDeafChanged = typeof update.deaf === "boolean" && player.voiceState.serverDeaf !== update.deaf;
+                const suppressChange = typeof update.suppress === "boolean" && player.voiceState.suppress !== update.suppress;
+                player.voiceState.selfDeaf = update.self_deaf ?? player.voiceState?.selfDeaf;
+                player.voiceState.selfMute = update.self_mute ?? player.voiceState?.selfMute;
+                player.voiceState.serverDeaf = update.deaf ?? player.voiceState?.serverDeaf;
+                player.voiceState.serverMute = update.mute ?? player.voiceState?.serverMute;
+                player.voiceState.suppress = update.suppress ?? player.voiceState?.suppress;
+                if (selfMuteChanged || serverMuteChanged)
+                    this.emit("playerMuteChange", player, player.voiceState.selfMute, player.voiceState.serverMute);
+                if (selfDeafChanged || serverDeafChanged)
+                    this.emit("playerDeafChange", player, player.voiceState.selfDeaf, player.voiceState.serverDeaf);
+                if (suppressChange)
+                    this.emit("playerSuppressChange", player, player.voiceState.suppress);
             }
             else {
                 if (this.options?.playerOptions?.onDisconnect?.destroyPlayer === true) {
@@ -532,11 +553,13 @@ class LavalinkManager extends events_1.EventEmitter {
                 if (this.options?.playerOptions?.onDisconnect?.autoReconnect === true) {
                     try {
                         const positionPrevios = player.position;
-                        this.emit("debug", Constants_1.DebugEvents.PlayerAutoReconnect, {
-                            state: "log",
-                            message: `Auto reconnecting player because LavalinkManager.options.playerOptions.onDisconnect.autoReconnect is true`,
-                            functionLayer: "LavalinkManager > sendRawData()",
-                        });
+                        if (this.options?.advancedOptions?.enableDebugEvents) {
+                            this.emit("debug", Constants_1.DebugEvents.PlayerAutoReconnect, {
+                                state: "log",
+                                message: `Auto reconnecting player because LavalinkManager.options.playerOptions.onDisconnect.autoReconnect is true`,
+                                functionLayer: "LavalinkManager > sendRawData()",
+                            });
+                        }
                         await player.connect();
                         // replay the current playing stream
                         await player.play({
@@ -554,7 +577,6 @@ class LavalinkManager extends events_1.EventEmitter {
                 player.voice = Object.assign({});
                 return;
             }
-            return;
         }
     }
 }

package/dist/cjs/structures/LavalinkManagerStatics.d.ts

@@ -7,7 +7,9 @@ export declare const LavalinkPlugins: {
     LavaSrc: string;
     GoogleCloudTTS: string;
     LavaSearch: string;
+    Jiosaavn_Plugin: string;
     LavalinkFilterPlugin: string;
+    JavaTimedLyricsPlugin: string;
 };
 /** Lavalink Sources regexes for url validations */
 export declare const SourceLinksRegexes: Record<SourcesRegex, RegExp>;

package/dist/cjs/structures/LavalinkManagerStatics.js

@@ -65,7 +65,12 @@ exports.DefaultSources = {
     "http": "http",
     "https": "https",
     "link": "link",
-    "uri": "uri"
+    "uri": "uri",
+    // jiosaavn
+    "jiosaavn": "jssearch",
+    "js": "jssearch",
+    "jssearch": "jssearch",
+    "jsrec": "jsrec"
 };
 /** Lavalink Plugins definiton */
 exports.LavalinkPlugins = {
@@ -73,7 +78,9 @@ exports.LavalinkPlugins = {
     LavaSrc: "lavasrc-plugin",
     GoogleCloudTTS: "tts-plugin",
     LavaSearch: "lavasearch-plugin",
-    LavalinkFilterPlugin: "lavalink-filter-plugin"
+    Jiosaavn_Plugin: "jiosaavn-plugin",
+    LavalinkFilterPlugin: "lavalink-filter-plugin",
+    JavaTimedLyricsPlugin: "java-lyrics-plugin"
 };
 /** Lavalink Sources regexes for url validations */
 exports.SourceLinksRegexes = {
@@ -111,6 +118,8 @@ exports.SourceLinksRegexes = {
     SpotifyAlbumRegex: /(https?:\/\/)(www\.)?open\.spotify\.com\/((?<region>[a-zA-Z-]+)\/)?(user\/(?<user>[a-zA-Z0-9-_]+)\/)?album\/(?<identifier>[a-zA-Z0-9-_]+)/,
     AllSpotifyRegex: /(https?:\/\/)(www\.)?open\.spotify\.com\/((?<region>[a-zA-Z-]+)\/)?(user\/(?<user>[a-zA-Z0-9-_]+)\/)?(?<type>track|album|playlist|artist|episode|show)\/(?<identifier>[a-zA-Z0-9-_]+)/,
     appleMusic: /https?:\/\/?(?:www\.)?music\.apple\.com\/(\S+)/,
+    /** From jiosaavn-plugin */
+    jiosaavn: /(https?:\/\/)(www\.)?jiosaavn\.com\/(?<type>song|album|featured|artist)\/([a-zA-Z0-9-_\/,]+)/,
     /** FROM DUNCTE BOT PLUGIN */
     tiktok: /https:\/\/www\.tiktok\.com\//,
     mixcloud: /https:\/\/www\.mixcloud\.com\//,