lavalink-client 2.10.0 → 2.10.2

package/dist/index.js

@@ -421,8 +421,6 @@ var DefaultSources = {
   pandora: "pdsearch",
   pd: "pdsearch",
   pdsearch: "pdsearch",
-  pdisrc: "pdisrc",
-  pdrec: "pdrec",
   "pandora music": "pdsearch",
   pandoramusic: "pdsearch",
   // speak PLUGIN
@@ -457,7 +455,15 @@ var DefaultSources = {
   jiosaavn: "jssearch",
   js: "jssearch",
   jssearch: "jssearch",
-  jsrec: "jsrec"
+  jsrec: "jsrec",
+  // amazon music
+  amzsearch: "amzsearch",
+  // audiomack
+  admsearch: "admsearch",
+  // gaana
+  gnsearch: "gnsearch",
+  // shazam
+  szsearch: "szsearch"
 };
 var LavalinkPlugins = {
   DuncteBot_Plugin: "DuncteBot-plugin",
@@ -466,7 +472,8 @@ var LavalinkPlugins = {
   LavaSearch: "lavasearch-plugin",
   Jiosaavn_Plugin: "jiosaavn-plugin",
   LavalinkFilterPlugin: "lavalink-filter-plugin",
-  JavaTimedLyricsPlugin: "java-lyrics-plugin"
+  JavaTimedLyricsPlugin: "java-lyrics-plugin",
+  PulseLinkPlugin: "pulselink-plugin"
 };
 var SourceLinksRegexes = {
   /** DEFAULT SUPPORTED BY LAVALINK */
@@ -542,6 +549,8 @@ function parseLavalinkConnUrl(connectionUrl) {
 }
 var ManagerUtils = class {
   LavalinkManager = void 0;
+  /** Override this with your custom sources record if you want to use custom sources for your node */
+  SourcesRecord = DefaultSources;
   constructor(LavalinkManager2) {
     this.LavalinkManager = LavalinkManager2;
   }
@@ -869,13 +878,13 @@ var ManagerUtils = class {
     return;
   }
   /**
-   * Finds the source of a query string by checking if it starts with a valid source prefix defined in the DefaultSources object. If a valid source prefix is found, it returns the corresponding SearchPlatform; otherwise, it returns null. This function is useful for determining the intended search platform for a given query string, allowing for more accurate search results when the user specifies a source (e.g., "ytsearch:Never Gonna Give You Up" would indicate that the search should be performed on YouTube).
+   * Finds the source of a query string by checking if it starts with a valid source prefix defined in the Default Sources object. If a valid source prefix is found, it returns the corresponding SearchPlatform; otherwise, it returns null. This function is useful for determining the intended search platform for a given query string, allowing for more accurate search results when the user specifies a source (e.g., "ytsearch:Never Gonna Give You Up" would indicate that the search should be performed on YouTube).
    * @param queryString
    * @returns
    */
   findSourceOfQuery(queryString) {
-    const foundSource = Object.keys(DefaultSources).find((source) => queryString?.toLowerCase?.()?.startsWith(`${source}:`.toLowerCase()))?.trim?.()?.toLowerCase?.();
-    if (foundSource && !["https", "http"].includes(foundSource) && DefaultSources[foundSource]) {
+    const foundSource = Object.keys(this.SourcesRecord).find((source) => queryString?.toLowerCase?.()?.startsWith(`${source}:`.toLowerCase()))?.trim?.()?.toLowerCase?.();
+    if (foundSource && !["https", "http"].includes(foundSource) && this.SourcesRecord[foundSource]) {
       return foundSource;
     }
     return null;
@@ -888,7 +897,7 @@ var ManagerUtils = class {
   extractSourceOfQuery(searchQuery) {
     const foundSource = this.findSourceOfQuery(searchQuery.query);
     if (foundSource) {
-      searchQuery.source = DefaultSources[foundSource];
+      searchQuery.source = this.SourcesRecord[foundSource];
       searchQuery.query = searchQuery.query.slice(`${foundSource}:`.length, searchQuery.query.length);
     }
     return searchQuery;
@@ -919,7 +928,7 @@ var ManagerUtils = class {
       return this.extractSourceOfQuery(Query);
     }
     const providedSource = query?.source?.trim?.()?.toLowerCase?.();
-    const validSourceExtracted = DefaultSources[providedSource ?? typedDefault];
+    const validSourceExtracted = this.SourcesRecord[providedSource ?? typedDefault];
     return this.extractSourceOfQuery({
       query: query.query,
       extraQueryUrlParams: query.extraQueryUrlParams,
@@ -943,7 +952,7 @@ var ManagerUtils = class {
       return this.extractSourceOfQuery(Query2);
     }
     const providedSource = query?.source?.trim?.()?.toLowerCase?.();
-    const validSourceExtracted = DefaultSources[providedSource ?? typedDefault];
+    const validSourceExtracted = this.SourcesRecord[providedSource ?? typedDefault];
     const Query = {
       query: query.query,
       types: query.types ? ["track", "playlist", "artist", "album", "text"].filter(
@@ -967,7 +976,7 @@ var ManagerUtils = class {
    */
   validateSourceString(node, sourceString) {
     if (!sourceString) throw new Error(`No SourceString was provided`);
-    const source = DefaultSources[sourceString.toLowerCase().trim()];
+    const source = this.SourcesRecord[sourceString.toLowerCase().trim()];
     if (!source && !!this.LavalinkManager.options.playerOptions.allowCustomSources)
       throw new Error(
         `Lavalink-Client does not support SearchQuerySource: '${sourceString}'. You can disable this check by setting 'ManagerOptions.PlayerOptions.allowCustomSources' to true`
@@ -1045,6 +1054,18 @@ var ManagerUtils = class {
     if (["pdsearch", "pdisrc", "pdrec"].includes(source) && !node.info?.sourceManagers?.includes("pandora")) {
       throw new Error("Lavalink Node has not 'pandora' enabled, which is required to have '" + source + "' work");
     }
+    if (source === "amzsearch" && !node.info?.sourceManagers?.includes("amazonmusic")) {
+      throw new Error("Lavalink Node has not 'amazonmusic' enabled, which is required to have 'amzsearch' work");
+    }
+    if (source === "admsearch" && !node.info?.sourceManagers?.includes("audiomack")) {
+      throw new Error("Lavalink Node has not 'audiomack' enabled, which is required to have 'admsearch' work");
+    }
+    if (source === "gnsearch" && !node.info?.sourceManagers?.includes("gaana")) {
+      throw new Error("Lavalink Node has not 'gaana' enabled, which is required to have 'gnsearch' work");
+    }
+    if (source === "szsearch" && !node.info?.sourceManagers?.includes("shazam")) {
+      throw new Error("Lavalink Node has not 'shazam' enabled, which is required to have 'szsearch' work");
+    }
     return;
   }
 };
@@ -1367,8 +1388,10 @@ var LavalinkNode = class _LavalinkNode {
       path: `/${this.version}/${endpoint.startsWith("/") ? endpoint.slice(1) : endpoint}`,
       method: "GET",
       headers: {
-        Authorization: this.options.authorization
+        Authorization: this.options.authorization,
+        ...this.NodeManager.LavalinkManager?.options?.httpHeaders
       },
+      // if httpHeaders is undefined/null, it won't be added, so we can keept it short like this
       signal: this.options.requestSignalTimeoutMS && this.options.requestSignalTimeoutMS > 0 ? AbortSignal.timeout(this.options.requestSignalTimeoutMS) : void 0
     };
     modify?.(options);
@@ -1481,10 +1504,8 @@ var LavalinkNode = class _LavalinkNode {
     if (Query.source) this._LManager.utils.validateSourceString(this, Query.source);
     if (/^https?:\/\//.test(Query.query))
       return this.search({ query: Query.query, source: Query.source }, requestUser);
-    if (!["spsearch", "sprec", "amsearch", "dzsearch", "dzisrc", "ytmsearch", "ytsearch"].includes(Query.source))
-      throw new SyntaxError(
-        `Query.source must be a source from LavaSrc: "spsearch" | "sprec" | "amsearch" | "dzsearch" | "dzisrc" | "ytmsearch" | "ytsearch"`
-      );
+    if (!this.isLavaSrcSource(Query.source))
+      throw new SyntaxError(`Query.source must be an available source from LavaSrc`);
     if (this._checkForPlugins && !this.info?.plugins?.find?.((v) => v.name === "lavasearch-plugin"))
       throw new RangeError(`there is no lavasearch-plugin available in the lavalink node: ${this.id}`);
     if (this._checkForPlugins && !this.info?.plugins?.find?.((v) => v.name === "lavasrc-plugin"))
@@ -1605,7 +1626,8 @@ var LavalinkNode = class _LavalinkNode {
       "Client-Name": String(this._LManager.options.client.username || "Lavalink-Client").replace(
         /[^\x20-\x7E]/g,
         ""
-      )
+      ),
+      ...this.NodeManager.LavalinkManager.options?.httpHeaders
     };
     if (typeof this.options.sessionId === "string" || typeof sessionId === "string") {
       headers["Session-Id"] = this.options.sessionId || sessionId;
@@ -1910,7 +1932,10 @@ var LavalinkNode = class _LavalinkNode {
         throw new RangeError(
           `there is no lyrics source (via lavasrc-plugin / java-lyrics-plugin) available in the lavalink node (required for lyrics): ${this.id}`
         );
-      const url = `/lyrics?track=${track.encoded}&skipTrackSource=${skipTrackSource}`;
+      let url = `/lyrics?track=${track.encoded}&skipTrackSource=${skipTrackSource}`;
+      if (this.nodeType === "NodeLink" /* NodeLink */) {
+        url = `/loadlyrics?encodedTrack=${track.encoded}`;
+      }
       return await this.request(url);
     },
     /**
@@ -1936,7 +1961,10 @@ var LavalinkNode = class _LavalinkNode {
         throw new RangeError(
           `there is no lyrics source (via lavasrc-plugin / java-lyrics-plugin) available in the lavalink node (required for lyrics): ${this.id}`
         );
-      const url = `/sessions/${this.sessionId}/players/${guildId}/track/lyrics?skipTrackSource=${skipTrackSource}`;
+      let url = `/sessions/${this.sessionId}/players/${guildId}/track/lyrics?skipTrackSource=${skipTrackSource}`;
+      if (this.nodeType === "NodeLink" /* NodeLink */) {
+        url = `/loadlyrics?encodedTrack=${this._LManager.getPlayer(guildId)?.queue.current?.encoded}`;
+      }
       return await this.request(url);
     },
     /**
@@ -3069,9 +3097,134 @@ var LavalinkNode = class _LavalinkNode {
     this._LManager.emit("LyricsNotFound", player, track, payload);
     return;
   }
+  /**
+   * @private
+   * util function to check if a provided source is valid with current node.
+   * @param {LavalinkSearchPlatform} src
+   * @returns {boolean} True if provided source is valid.
+   */
+  isLavaSrcSource(src) {
+    const source = /* @__PURE__ */ new Set([]);
+    if (this.info?.sourceManagers.includes("spotify")) source.add("spsearch").add("sprec");
+    if (this.info?.sourceManagers.includes("applemusic")) source.add("amsearch");
+    if (this.info?.sourceManagers.includes("deezer")) source.add("dzsearch").add("dzrec").add("dzisrc");
+    if (this.info?.sourceManagers.includes("yandexmusic")) source.add("ymsearch").add("ymrec");
+    if (this.info?.sourceManagers.includes("vkmusic")) source.add("vksearch").add("vkrec");
+    if (this.info?.sourceManagers.includes("tidal")) source.add("tdsearch").add("tdrec");
+    if (this.info?.sourceManagers.includes("qobuz")) source.add("qbsearch").add("qbisrc").add("qbrec");
+    if (this.info?.sourceManagers.includes("youtube")) source.add("ytsearch").add("ytmsearch");
+    return typeof src === "string" && source.has(src);
+  }
 };
 
 // src/structures/NodeLink.ts
+var NodeLinkDefaultSources = {
+  // youtubemusic
+  "youtube music": "ytmsearch",
+  youtubemusic: "ytmsearch",
+  ytmsearch: "ytmsearch",
+  ytm: "ytmsearch",
+  musicyoutube: "ytmsearch",
+  "music youtube": "ytmsearch",
+  // youtube
+  youtube: "ytsearch",
+  yt: "ytsearch",
+  ytsearch: "ytsearch",
+  // soundcloud
+  soundcloud: "scsearch",
+  scsearch: "scsearch",
+  sc: "scsearch",
+  // apple music
+  "apple music": "amsearch",
+  apple: "amsearch",
+  applemusic: "amsearch",
+  amsearch: "amsearch",
+  am: "amsearch",
+  musicapple: "amsearch",
+  "music apple": "amsearch",
+  // spotify
+  spotify: "spsearch",
+  spsearch: "spsearch",
+  sp: "spsearch",
+  "spotify.com": "spsearch",
+  spotifycom: "spsearch",
+  sprec: "sprec",
+  spsuggestion: "sprec",
+  // deezer
+  deezer: "dzsearch",
+  dz: "dzsearch",
+  dzsearch: "dzsearch",
+  dzisrc: "dzsearch",
+  // NodeLink doesn't expose `dzisrc` as a prefix string
+  dzrec: "dzrec",
+  // yandexmusic
+  "yandex music": "ymsearch",
+  yandexmusic: "ymsearch",
+  yandex: "ymsearch",
+  ymsearch: "ymsearch",
+  ymrec: "ymsearch",
+  // VK Music
+  vksearch: "vksearch",
+  vkmusic: "vksearch",
+  "vk music": "vksearch",
+  vkrec: "vkrec",
+  vk: "vksearch",
+  // Qobuz
+  qbsearch: "qbsearch",
+  qobuz: "qbsearch",
+  qbisrc: "qbsearch",
+  // NodeLink doesn't expose `qbisrc` as a prefix string
+  qbrec: "qbsearch",
+  // NodeLink doesn't expose `qbrec` as a prefix string
+  // pandora
+  pandora: "pdsearch",
+  pd: "pdsearch",
+  pdsearch: "pdsearch",
+  "pandora music": "pdsearch",
+  pandoramusic: "pdsearch",
+  // speak PLUGIN
+  speak: "speak",
+  // Map Lavalink's `tts` prefix to NodeLink's `gtts`
+  tts: "gtts",
+  ftts: "ftts",
+  flowery: "flowery",
+  "flowery.tts": "flowery",
+  flowerytts: "flowery",
+  // Client sided search platforms
+  bandcamp: "bcsearch",
+  bc: "bcsearch",
+  bcsearch: "bcsearch",
+  // other searches (not supported explicitly in NodeLink prefixes)
+  phsearch: "search",
+  pornhub: "search",
+  porn: "search",
+  // local files
+  local: "local",
+  // http requests
+  http: "http",
+  https: "https",
+  link: "link",
+  uri: "uri",
+  // tidal
+  tidal: "tdsearch",
+  td: "tdsearch",
+  "tidal music": "tdsearch",
+  tdsearch: "tdsearch",
+  tdrec: "tdrec",
+  // jiosaavn
+  jiosaavn: "jssearch",
+  js: "jssearch",
+  jssearch: "jssearch",
+  jsrec: "jsrec",
+  amzsearch: "amsearch",
+  // amazon music (falls back to Apple Music search on NodeLink)
+  // audiomack
+  admsearch: "admsearch",
+  // gaana
+  gnsearch: "gaanasearch",
+  // shazam
+  szsearch: "szsearch"
+};
 var NodeLinkNode = class extends LavalinkNode {
   nodeType = "NodeLink" /* NodeLink */;
   constructor(options, manager) {
@@ -6027,7 +6180,7 @@ var Player = class {
         );
       if (this.queue.current || this.queue.tracks.length) {
         const trackSources = new Set(
-          [this.queue.current, ...this.queue.tracks].map((track) => track.info.sourceName)
+          [this.queue.current, ...this.queue.tracks].map((track) => track?.info?.sourceName).filter(Boolean)
         );
         const missingSources = [...trackSources].filter(
           (source) => !updateNode.info?.sourceManagers.includes(source)
@@ -6274,6 +6427,7 @@ var LavalinkManager = class _LavalinkManager extends EventEmitter2 {
         queueChangesWatcher: options?.queueOptions?.queueChangesWatcher ?? null,
         queueStore: options?.queueOptions?.queueStore ?? new DefaultQueueStore()
       },
+      httpHeaders: options?.httpHeaders ?? {},
       advancedOptions: {
         enableDebugEvents: options?.advancedOptions?.enableDebugEvents ?? false,
         maxFilterFixDuration: options?.advancedOptions?.maxFilterFixDuration ?? 6e5,
@@ -6327,6 +6481,19 @@ var LavalinkManager = class _LavalinkManager extends EventEmitter2 {
     }
     if (typeof options?.queueOptions?.maxPreviousTracks !== "number" || options?.queueOptions?.maxPreviousTracks < 0)
       options.queueOptions.maxPreviousTracks = 25;
+    if (options?.httpHeaders) {
+      if (typeof options.httpHeaders !== "object" || Array.isArray(options.httpHeaders))
+        throw new SyntaxError("ManagerOption.httpHeaders must be an object with string keys and string values");
+      const forbiddenHeaders = ["authorization", "user-id", "client-name", "session-id"];
+      for (const header in options.httpHeaders) {
+        if (forbiddenHeaders.includes(header.toLowerCase()))
+          throw new SyntaxError(
+            `ManagerOption.httpHeaders cannot have the following headers: ${forbiddenHeaders.join(", ")}`
+          );
+        if (typeof options.httpHeaders[header] !== "string")
+          throw new SyntaxError(`ManagerOption.httpHeaders values must be of type string :: ${header}`);
+      }
+    }
   }
   /**
    * Emits a debug event to the LavalinkManager
@@ -6810,6 +6977,7 @@ export {
   LavalinkPlugins,
   ManagerUtils,
   MiniMap,
+  NodeLinkDefaultSources,
   NodeLinkExclusiveEvents,
   NodeLinkNode,
   NodeManager,