magmastream 2.10.3-alpha.7 → 2.10.3-alpha.9

package/dist/structures/Enums.d.ts

@@ -73,9 +73,18 @@ export declare enum SearchPlatform {
     YouTubeMusic = "ytmsearch"
 }
 /**
- * NodeLink-only Search Platform Enum
+ * NodeLink Search Platform Enum
  */
 export declare enum NodeLinkSearchPlatform {
+    Unified = "search",
+    YouTube = "ytsearch",
+    YouTubeMusic = "ytmsearch",
+    SoundCloud = "scsearch",
+    Spotify = "spsearch",
+    AppleMusic = "amsearch",
+    Deezer = "dzsearch",
+    Tidal = "tdsearch",
+    Bandcamp = "bcsearch",
     AmazonMusic = "amazonmusic",
     AmazonMusicSearch = "azsearch",
     Anghami = "agsearch",
@@ -85,14 +94,19 @@ export declare enum NodeLinkSearchPlatform {
     Bilibili = "bilibili",
     BilibiliSearch = "bilisearch",
     Bluesky = "bksearch",
+    EternalBoxDirect = "eternalbox",
+    EternalBox = "ebox",
+    EternalBoxJukebox = "jukebox",
     Flowery = "flowery",
     FloweryTTS = "ftts",
     Gaana = "gaanasearch",
     GaanaSearch = "gnsearch",
     GoogleDrive = "gdsearch",
     GoogleTTS = "gtts",
+    GoogleTTSSpeak = "speak",
     IHeartRadio = "iheartradio",
     IHeartRadioSearch = "ihsearch",
+    Jiosaavn = "jssearch",
     LastFM = "lfsearch",
     LazyTTS = "lazypytts",
     LazyTTSAlt = "lazytts",
@@ -104,9 +118,35 @@ export declare enum NodeLinkSearchPlatform {
     NicoVideoSearch = "ncsearch",
     Pandora = "pdsearch",
     PiperTTS = "pipertts",
+    Qobuz = "qbsearch",
     Shazam = "shsearch",
     ShazamAlt = "szsearch",
-    SongLink = "slsearch"
+    SongLink = "slsearch",
+    VKMusic = "vksearch",
+    Yandex = "ymsearch"
+}
+/**
+ * NodeLink Search Type Modifier Enum
+ */
+export declare enum NodeLinkSearchType {
+    Track = "track",
+    Playlist = "playlist",
+    Album = "album",
+    Artist = "artist",
+    Channel = "channel",
+    User = "user",
+    Users = "users",
+    People = "people",
+    Tracks = "tracks",
+    Sounds = "sounds",
+    Sound = "sound",
+    Albums = "albums",
+    Playlists = "playlists",
+    Set = "set",
+    Sets = "sets",
+    All = "all",
+    Everything = "everything",
+    Video = "video"
 }
 /**
  * Player State Event Types Enum

package/dist/structures/Enums.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MagmaStreamErrorNumbers = exports.MagmaStreamErrorCode = exports.AvailableFilters = exports.SponsorBlockSegment = exports.SeverityTypes = exports.TrackEndReasonTypes = exports.ManagerEventTypes = exports.TrackPartial = exports.UseNodeOptions = exports.TrackSourceTypes = exports.PlayerStateEventTypes = exports.NodeLinkSearchPlatform = exports.SearchPlatform = exports.LoadTypes = exports.StateTypes = exports.AutoPlayPlatform = exports.StateStorageType = void 0;
+exports.MagmaStreamErrorNumbers = exports.MagmaStreamErrorCode = exports.AvailableFilters = exports.SponsorBlockSegment = exports.SeverityTypes = exports.TrackEndReasonTypes = exports.ManagerEventTypes = exports.TrackPartial = exports.UseNodeOptions = exports.TrackSourceTypes = exports.PlayerStateEventTypes = exports.NodeLinkSearchType = exports.NodeLinkSearchPlatform = exports.SearchPlatform = exports.LoadTypes = exports.StateTypes = exports.AutoPlayPlatform = exports.StateStorageType = void 0;
 /**
  * State Storage Enum
  */
@@ -81,10 +81,19 @@ var SearchPlatform;
     SearchPlatform["YouTubeMusic"] = "ytmsearch";
 })(SearchPlatform || (exports.SearchPlatform = SearchPlatform = {}));
 /**
- * NodeLink-only Search Platform Enum
+ * NodeLink Search Platform Enum
  */
 var NodeLinkSearchPlatform;
 (function (NodeLinkSearchPlatform) {
+    NodeLinkSearchPlatform["Unified"] = "search";
+    NodeLinkSearchPlatform["YouTube"] = "ytsearch";
+    NodeLinkSearchPlatform["YouTubeMusic"] = "ytmsearch";
+    NodeLinkSearchPlatform["SoundCloud"] = "scsearch";
+    NodeLinkSearchPlatform["Spotify"] = "spsearch";
+    NodeLinkSearchPlatform["AppleMusic"] = "amsearch";
+    NodeLinkSearchPlatform["Deezer"] = "dzsearch";
+    NodeLinkSearchPlatform["Tidal"] = "tdsearch";
+    NodeLinkSearchPlatform["Bandcamp"] = "bcsearch";
     NodeLinkSearchPlatform["AmazonMusic"] = "amazonmusic";
     NodeLinkSearchPlatform["AmazonMusicSearch"] = "azsearch";
     NodeLinkSearchPlatform["Anghami"] = "agsearch";
@@ -94,14 +103,19 @@ var NodeLinkSearchPlatform;
     NodeLinkSearchPlatform["Bilibili"] = "bilibili";
     NodeLinkSearchPlatform["BilibiliSearch"] = "bilisearch";
     NodeLinkSearchPlatform["Bluesky"] = "bksearch";
+    NodeLinkSearchPlatform["EternalBoxDirect"] = "eternalbox";
+    NodeLinkSearchPlatform["EternalBox"] = "ebox";
+    NodeLinkSearchPlatform["EternalBoxJukebox"] = "jukebox";
     NodeLinkSearchPlatform["Flowery"] = "flowery";
     NodeLinkSearchPlatform["FloweryTTS"] = "ftts";
     NodeLinkSearchPlatform["Gaana"] = "gaanasearch";
     NodeLinkSearchPlatform["GaanaSearch"] = "gnsearch";
     NodeLinkSearchPlatform["GoogleDrive"] = "gdsearch";
     NodeLinkSearchPlatform["GoogleTTS"] = "gtts";
+    NodeLinkSearchPlatform["GoogleTTSSpeak"] = "speak";
     NodeLinkSearchPlatform["IHeartRadio"] = "iheartradio";
     NodeLinkSearchPlatform["IHeartRadioSearch"] = "ihsearch";
+    NodeLinkSearchPlatform["Jiosaavn"] = "jssearch";
     NodeLinkSearchPlatform["LastFM"] = "lfsearch";
     NodeLinkSearchPlatform["LazyTTS"] = "lazypytts";
     NodeLinkSearchPlatform["LazyTTSAlt"] = "lazytts";
@@ -113,10 +127,37 @@ var NodeLinkSearchPlatform;
     NodeLinkSearchPlatform["NicoVideoSearch"] = "ncsearch";
     NodeLinkSearchPlatform["Pandora"] = "pdsearch";
     NodeLinkSearchPlatform["PiperTTS"] = "pipertts";
+    NodeLinkSearchPlatform["Qobuz"] = "qbsearch";
     NodeLinkSearchPlatform["Shazam"] = "shsearch";
     NodeLinkSearchPlatform["ShazamAlt"] = "szsearch";
     NodeLinkSearchPlatform["SongLink"] = "slsearch";
+    NodeLinkSearchPlatform["VKMusic"] = "vksearch";
+    NodeLinkSearchPlatform["Yandex"] = "ymsearch";
 })(NodeLinkSearchPlatform || (exports.NodeLinkSearchPlatform = NodeLinkSearchPlatform = {}));
+/**
+ * NodeLink Search Type Modifier Enum
+ */
+var NodeLinkSearchType;
+(function (NodeLinkSearchType) {
+    NodeLinkSearchType["Track"] = "track";
+    NodeLinkSearchType["Playlist"] = "playlist";
+    NodeLinkSearchType["Album"] = "album";
+    NodeLinkSearchType["Artist"] = "artist";
+    NodeLinkSearchType["Channel"] = "channel";
+    NodeLinkSearchType["User"] = "user";
+    NodeLinkSearchType["Users"] = "users";
+    NodeLinkSearchType["People"] = "people";
+    NodeLinkSearchType["Tracks"] = "tracks";
+    NodeLinkSearchType["Sounds"] = "sounds";
+    NodeLinkSearchType["Sound"] = "sound";
+    NodeLinkSearchType["Albums"] = "albums";
+    NodeLinkSearchType["Playlists"] = "playlists";
+    NodeLinkSearchType["Set"] = "set";
+    NodeLinkSearchType["Sets"] = "sets";
+    NodeLinkSearchType["All"] = "all";
+    NodeLinkSearchType["Everything"] = "everything";
+    NodeLinkSearchType["Video"] = "video";
+})(NodeLinkSearchType || (exports.NodeLinkSearchType = NodeLinkSearchType = {}));
 /**
  * Player State Event Types Enum
  */

package/dist/structures/Filters.js

@@ -80,7 +80,6 @@ class Filters {
             distortion,
             equalizer,
             karaoke,
-            lowPass,
             pluginFilters,
             rotation,
             timescale,
@@ -94,6 +93,7 @@ class Filters {
                     compressor,
                     echo,
                     flanger,
+                    lowpass: lowPass,
                     highpass,
                     phaser,
                     phonograph,
@@ -101,7 +101,9 @@ class Filters {
                     spatial,
                     tape,
                 }
-                : {}),
+                : {
+                    lowPass,
+                }),
         };
         try {
             await this.player.node.rest.updatePlayer({

package/dist/structures/Manager.d.ts

@@ -135,8 +135,11 @@ export declare class Manager extends EventEmitter {
      * @returns A promise that resolves when the player states have been loaded.
      */
     loadPlayerStates(nodeId: string): Promise<void>;
+    private normalizeSearchType;
+    private buildLoadTracksIdentifier;
     private isNodeLinkSearchSource;
     private isPrefixedLoadTracksIdentifier;
+    private hasNodeLinkSearchTypeModifier;
     private requiresNodeLinkSearchNode;
     private requiresLavalinkSearchNode;
     private getSearchNode;

package/dist/structures/Manager.js

@@ -21,7 +21,10 @@ function escapeRegExp(value) {
 }
 const YOUTUBE_URL_PATTERN = /(youtube\.com|youtu\.be)/;
 const BLOCKED_WORDS_PATTERN = new RegExp(`\\b(${blockedWords_1.blockedWords.map(escapeRegExp).join("|")})\\b`, "gi");
+const PORTABLE_SEARCH_PREFIXES = new Set(Object.values(Enums_1.SearchPlatform).map((source) => source.toLowerCase()));
 const NODELINK_SEARCH_PREFIXES = new Set(Object.values(Enums_1.NodeLinkSearchPlatform).map((source) => source.toLowerCase()));
+const NODELINK_ONLY_SEARCH_PREFIXES = new Set([...NODELINK_SEARCH_PREFIXES].filter((source) => !PORTABLE_SEARCH_PREFIXES.has(source)));
+const NODELINK_SEARCH_TYPE_MODIFIERS = new Set(Object.values(Enums_1.NodeLinkSearchType).map((type) => type.toLowerCase()));
 const KNOWN_LOADTRACKS_PREFIXES = new Set([
     ...Object.values(Enums_1.SearchPlatform).map((source) => source.toLowerCase()),
     ...NODELINK_SEARCH_PREFIXES,
@@ -38,10 +41,15 @@ const KNOWN_LOADTRACKS_PREFIXES = new Set([
     "lmrec",
 ]);
 const NODELINK_ONLY_LOADTRACKS_PREFIXES = new Set(["ytrec", "jsrec", "lmrec"]);
+const SEARCH_TYPE_PATTERN = /^[A-Za-z0-9]+$/;
 function getIdentifierPrefix(identifier) {
     const match = /^([A-Za-z0-9]+):/.exec(identifier);
     return match?.[1]?.toLowerCase() ?? null;
 }
+function getIdentifierSearchType(identifier) {
+    const match = /^[A-Za-z0-9]+:([A-Za-z0-9]+):/.exec(identifier);
+    return match?.[1]?.toLowerCase() ?? null;
+}
 /**
  * The main hub for interacting with Lavalink and using Magmastream.
  */
@@ -224,15 +232,16 @@ class Manager extends events_1.EventEmitter {
      */
     async search(query, requester) {
         const _query = typeof query === "string" ? { query } : query;
-        const _source = _query.source ?? this.options.defaultSearchPlatform;
+        const _source = _query.source ?? this.options.defaultSearchPlatform ?? Enums_1.SearchPlatform.YouTube;
         const isUrl = /^https?:\/\//.test(_query.query);
         const isPrefixedIdentifier = this.isPrefixedLoadTracksIdentifier(_query.query);
-        const search = isUrl || isPrefixedIdentifier ? _query.query : `${_source}:${_query.query}`;
-        const node = this.getSearchNode(_source, search);
+        const searchType = this.normalizeSearchType(_query.searchType);
+        const search = this.buildLoadTracksIdentifier(_source, _query.query, searchType, isUrl, isPrefixedIdentifier);
+        const node = this.getSearchNode(_source, search, searchType);
         if (!node) {
             throw new MagmastreamError_1.MagmaStreamError({
                 code: Enums_1.MagmaStreamErrorCode.MANAGER_NO_NODES,
-                message: this.requiresNodeLinkSearchNode(_source, search)
+                message: this.requiresNodeLinkSearchNode(_source, search, searchType)
                     ? "No available NodeLink nodes to perform the NodeLink-specific search."
                     : this.requiresLavalinkSearchNode(search)
                         ? "No available Lavalink nodes to perform the Lavalink-specific search."
@@ -241,8 +250,8 @@ class Manager extends events_1.EventEmitter {
             });
         }
         this.emit(Enums_1.ManagerEventTypes.Debug, isUrl || isPrefixedIdentifier
-            ? `[MANAGER] Performing search on ${node.options.identifier} for: ${_query.query}`
-            : `[MANAGER] Performing ${_source} search on ${node.options.identifier} for: ${_query.query}`);
+            ? `[MANAGER] Performing search on ${node.options.identifier} for: ${search}`
+            : `[MANAGER] Performing ${_source}${searchType ? `:${searchType}` : ""} search on ${node.options.identifier} for: ${_query.query}`);
         try {
             const lavalinkResponse = (await node.rest.get(`/v4/loadtracks?identifier=${encodeURIComponent(search)}`));
             if (!lavalinkResponse) {
@@ -759,20 +768,54 @@ class Manager extends events_1.EventEmitter {
         this.emit(Enums_1.ManagerEventTypes.Debug, "[MANAGER] Finished loading saved players.");
         this.emit(Enums_1.ManagerEventTypes.RestoreComplete, node);
     }
+    normalizeSearchType(searchType) {
+        if (searchType === undefined || searchType === null)
+            return null;
+        if (typeof searchType !== "string" || !SEARCH_TYPE_PATTERN.test(searchType)) {
+            throw new MagmastreamError_1.MagmaStreamError({
+                code: Enums_1.MagmaStreamErrorCode.MANAGER_SEARCH_FAILED,
+                message: 'Search option "searchType" must be an alphanumeric NodeLink search type modifier.',
+                context: { searchType },
+            });
+        }
+        return searchType.toLowerCase();
+    }
+    buildLoadTracksIdentifier(source, query, searchType, isUrl, isPrefixedIdentifier) {
+        if (isUrl)
+            return query;
+        if (isPrefixedIdentifier) {
+            if (!searchType || this.hasNodeLinkSearchTypeModifier(query))
+                return query;
+            const prefix = getIdentifierPrefix(query);
+            if (!prefix)
+                return query;
+            return `${prefix}:${searchType}:${query.slice(prefix.length + 1)}`;
+        }
+        return searchType ? `${source}:${searchType}:${query}` : `${source}:${query}`;
+    }
     isNodeLinkSearchSource(source) {
-        return typeof source === "string" && NODELINK_SEARCH_PREFIXES.has(source.toLowerCase());
+        return typeof source === "string" && NODELINK_ONLY_SEARCH_PREFIXES.has(source.toLowerCase());
     }
     isPrefixedLoadTracksIdentifier(identifier) {
         const prefix = getIdentifierPrefix(identifier);
         return prefix !== null && KNOWN_LOADTRACKS_PREFIXES.has(prefix);
     }
-    requiresNodeLinkSearchNode(source, identifier) {
+    hasNodeLinkSearchTypeModifier(identifier) {
+        const prefix = getIdentifierPrefix(identifier);
+        const searchType = getIdentifierSearchType(identifier);
+        return prefix !== null && searchType !== null && KNOWN_LOADTRACKS_PREFIXES.has(prefix) && NODELINK_SEARCH_TYPE_MODIFIERS.has(searchType);
+    }
+    requiresNodeLinkSearchNode(source, identifier, searchType) {
+        if (searchType)
+            return true;
         if (this.isNodeLinkSearchSource(source))
             return true;
         const prefix = getIdentifierPrefix(identifier);
         if (prefix === null)
             return false;
-        if (NODELINK_SEARCH_PREFIXES.has(prefix) || NODELINK_ONLY_LOADTRACKS_PREFIXES.has(prefix))
+        if (NODELINK_ONLY_SEARCH_PREFIXES.has(prefix) || NODELINK_ONLY_LOADTRACKS_PREFIXES.has(prefix))
+            return true;
+        if (this.hasNodeLinkSearchTypeModifier(identifier))
             return true;
         const normalizedIdentifier = identifier.toLowerCase();
         return prefix === "sprec" && !normalizedIdentifier.startsWith("sprec:mix:");
@@ -780,13 +823,13 @@ class Manager extends events_1.EventEmitter {
     requiresLavalinkSearchNode(identifier) {
         return identifier.toLowerCase().startsWith("sprec:mix:");
     }
-    getSearchNode(source, identifier) {
-        if (this.requiresNodeLinkSearchNode(source, identifier)) {
-            return this.getPreferredNode((node) => node.isNodeLink);
-        }
+    getSearchNode(source, identifier, searchType) {
         if (this.requiresLavalinkSearchNode(identifier)) {
             return this.getPreferredNode((node) => !node.isNodeLink);
         }
+        if (this.requiresNodeLinkSearchNode(source, identifier, searchType)) {
+            return this.getPreferredNode((node) => node.isNodeLink);
+        }
         return this.useableNode ?? null;
     }
     getPreferredNode(predicate) {

package/dist/structures/Node.js

@@ -569,9 +569,11 @@ class Node {
                 this.socketClosed(player, payload);
                 break;
             case "SegmentsLoaded":
+            case "SponsorBlockSegmentsLoadedEvent":
                 this.sponsorBlockSegmentLoaded(player, track, payload);
                 break;
             case "SegmentSkipped":
+            case "SponsorBlockSegmentSkippedEvent":
                 this.sponsorBlockSegmentSkipped(player, track, payload);
                 break;
             case "ChaptersLoaded":

package/dist/structures/Types.d.ts

@@ -6,7 +6,7 @@ import type { User as SeyfertUser, ClientUser as SeyfertClientUser, Message as S
 import { JsonQueue } from "../statestorage/JsonQueue";
 import { MemoryQueue } from "../statestorage/MemoryQueue";
 import { RedisQueue } from "../statestorage/RedisQueue";
-import { AutoPlayPlatform, LoadTypes, ManagerEventTypes, NodeLinkSearchPlatform, PlayerStateEventTypes, SearchPlatform, SeverityTypes, StateStorageType, TrackEndReasonTypes, TrackPartial, TrackSourceTypes, UseNodeOptions } from "./Enums";
+import { AutoPlayPlatform, LoadTypes, ManagerEventTypes, NodeLinkSearchPlatform, NodeLinkSearchType, PlayerStateEventTypes, SearchPlatform, SeverityTypes, StateStorageType, TrackEndReasonTypes, TrackPartial, TrackSourceTypes, UseNodeOptions } from "./Enums";
 import { Node } from "./Node";
 import { Player } from "./Player";
 import { Plugin } from "./Plugin";
@@ -426,6 +426,12 @@ export interface TrackPluginInfo {
 export interface SearchQuery {
     /** The source to search from. */
     source?: SearchSource;
+    /**
+     * NodeLink search type modifier.
+     *
+     * Builds identifiers like `ytsearch:playlist:query` and routes the search to a NodeLink node.
+     */
+    searchType?: NodeLinkSearchType | string;
     /** The query to search for. */
     query: string;
 }
@@ -798,7 +804,7 @@ export interface WebSocketClosedEvent extends PlayerEvent {
  * SponsorBlockSegmentsLoaded interface
  */
 export interface SponsorBlockSegmentsLoaded extends PlayerEvent {
-    type: "SegmentsLoaded";
+    type: "SegmentsLoaded" | "SponsorBlockSegmentsLoadedEvent";
     segments: {
         category: string;
         start: number;
@@ -809,7 +815,7 @@ export interface SponsorBlockSegmentsLoaded extends PlayerEvent {
  * SponsorBlockSegmentSkipped interface
  */
 export interface SponsorBlockSegmentSkipped extends PlayerEvent {
-    type: "SegmentSkipped";
+    type: "SegmentSkipped" | "SponsorBlockSegmentSkippedEvent";
     segment: {
         category: string;
         start: number;
@@ -1554,6 +1560,7 @@ export interface LavalinkFilters {
     rotation?: RotationOptions | null;
     channelMix?: ChannelMixOptions | null;
     lowPass?: LowPassOptions | null;
+    lowpass?: LowPassOptions | null;
     highpass?: HighPassOptions | null;
     echo?: EchoOptions | null;
     reverb?: ReverbOptions | null;
@@ -1644,7 +1651,7 @@ export type TrackEndReason = keyof typeof TrackEndReasonTypes;
 /**
  * Player Event Type Enum type
  */
-export type PlayerEventType = "TrackStartEvent" | "TrackEndEvent" | "TrackExceptionEvent" | "TrackStuckEvent" | "MixStartedEvent" | "MixEndedEvent" | "WebSocketClosedEvent" | "SegmentSkipped" | "SegmentsLoaded" | "ChaptersLoaded" | "ChapterStarted" | "LyricsFoundEvent" | "LyricsNotFoundEvent" | "LyricsLineEvent";
+export type PlayerEventType = "TrackStartEvent" | "TrackEndEvent" | "TrackExceptionEvent" | "TrackStuckEvent" | "MixStartedEvent" | "MixEndedEvent" | "WebSocketClosedEvent" | "SegmentSkipped" | "SegmentsLoaded" | "SponsorBlockSegmentSkippedEvent" | "SponsorBlockSegmentsLoadedEvent" | "ChaptersLoaded" | "ChapterStarted" | "LyricsFoundEvent" | "LyricsNotFoundEvent" | "LyricsLineEvent";
 /**
  * Severity Types Enum type
  */
@@ -1656,7 +1663,7 @@ export type SponsorBlockSegmentEvents = SponsorBlockSegmentSkipped | SponsorBloc
 /**
  * SponsorBlock Segment Event Type Enum type
  */
-export type SponsorBlockSegmentEventType = "SegmentSkipped" | "SegmentsLoaded" | "ChapterStarted" | "ChaptersLoaded";
+export type SponsorBlockSegmentEventType = "SegmentSkipped" | "SegmentsLoaded" | "SponsorBlockSegmentSkippedEvent" | "SponsorBlockSegmentsLoadedEvent" | "ChapterStarted" | "ChaptersLoaded";
 /**
  * Player Events Enum type
  */

package/dist/structures/Utils.js

@@ -105,12 +105,15 @@ class TrackUtils {
                 bandcamp: "Bandcamp",
                 bilibili: "Bilibili",
                 deezer: "Deezer",
+                eternalbox: "EternalBox",
                 flowery: "Flowery",
                 gaana: "Gaana",
                 googledrive: "GoogleDrive",
                 googletts: "GoogleTTS",
+                iheartradio: "IHeartRadio",
                 jiosaavn: "Jiosaavn",
                 lastfm: "LastFM",
+                netease: "Netease",
                 soundcloud: "SoundCloud",
                 spotify: "Spotify",
                 tidal: "Tidal",

package/package.json

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